Bug #74976 ndb_index_stat boolean default values incorrect
Submitted: 24 Nov 2014 10:20 Modified: 27 Nov 2014 10:20
Reporter: Daniël van Eeden (OCA) Email Updates:
Status: Closed Impact on me:
None 
Category:MySQL Cluster: Documentation Severity:S3 (Non-critical)
Version:7.2.18 OS:Any
Assigned to: Jon Stephens CPU Architecture:Any

[24 Nov 2014 10:20] Daniël van Eeden
Description:
These three sources don't seem to agree on the defaults for --update and other options:
* ndb_index_stat --help
* NDB_INDEX_STAT(1)
* http://dev.mysql.com/doc/refman/5.5/en/mysql-cluster-programs-ndb-index-stat.html

How to repeat:
From NDB_INDEX_STAT(1) manpage:
---------------------------------------------
·   --update

           +--------------------+---------------------+
           |Command-Line Format | --update            |
           +--------------------+---------------------+
           |                    | Permitted Values    |
           |                    +-----------+---------+
           |                    | Type      | boolean |
           |                    +-----------+---------+
           |                    | Default   | true    |
           |                    +-----------+---------+
           |                    | Min Value |         |
           |                    +-----------+---------+
           |                    | Max Value |         |
           +--------------------+-----------+---------+
           Update the index statistics for the given table, and restart any auto-update that previously
           configured.
---------------------------------------------

ndb_index_stat --help:
---------------------------------------------

Variables (--variable-name=value)
and boolean options {FALSE|TRUE}  Value (after reading options)
--------------------------------- ----------------------------------------
update                            FALSE

---------------------------------------------
[24 Nov 2014 11:42] MySQL Verification Team
Hello Daniël,

Thank you for the report.

Thanks,
Umesh
[24 Nov 2014 11:49] MySQL Verification Team
// Indeed, doc and CLI default values differ

// 7.2.18

[root@cluster-repo mysql-7.2.18]# bin/ndb_index_stat --version
MySQL distrib mysql-5.5.40 ndb-7.2.18, for linux2.6 (x86_64)

[root@cluster-repo mysql-7.2.18]# bin/ndb_index_stat --help |grep update
                      auto update
  --update            Update index stats of given table and restart any
                      configured auto update
update                            FALSE
[root@cluster-repo mysql-7.2.18]#

// 7.4.2
[root@cluster-repo mysql-7.4.2]# bin/ndb_index_stat --help |grep update
                      auto update
  --update            Update index stats of given table and restart any
                      configured auto update
update                            FALSE
[root@cluster-repo mysql-7.4.2]#
[root@cluster-repo mysql-7.4.2]# bin/ndb_index_stat --version
MySQL distrib mysql-5.6.21 ndb-7.4.2, for linux-glibc2.5 (x86_64)

// 7.3.7

[root@cluster-repo cluster]# cd mysql-7.3.7
[root@cluster-repo mysql-7.3.7]# bin/ndb_index_stat --version
MySQL distrib mysql-5.6.21 ndb-7.3.7, for linux-glibc2.5 (x86_64)
[root@cluster-repo mysql-7.3.7]#
[root@cluster-repo mysql-7.3.7]# bin/ndb_index_stat --help |grep update
                      auto update
  --update            Update index stats of given table and restart any
                      configured auto update
update                            FALSE
[27 Nov 2014 10:20] Jon Stephens
Thank you for your bug report. This issue has been addressed in the documentation. The updated documentation will appear on our website shortly.

All the Boolean options for ndb_index_stat were encoded as "true (if used)" which (a) doesn't display correctly, and (b) is inconsistent with how other such Boolean options are encoded in the data files used to generate the option info tables that appear in the Manual for other MySQL & NDB programs. 

This fix corrects all such options for ndb_index_stat. (There were 11 of them, IIRC.)

The corrections should appear online within a day or so. Thanks for spotting this and letting us know about it.

cheers

jon.