Bug #57128 Wrong units documented for rpl_semi_sync_master_enabled & rpl_semi_sync_slave_en
Submitted: 30 Sep 2010 9:30 Modified: 30 Sep 2010 23:03
Reporter: Andrew Morgan Email Updates:
Status: Closed Impact on me:
None 
Category:MySQL Server: Documentation Severity:S3 (Non-critical)
Version:5.5.6-rc OS:Any
Assigned to: Paul DuBois CPU Architecture:Any

[30 Sep 2010 9:30] Andrew Morgan
Description:
The documentation at http://dev.mysql.com/doc/refman/5.5/en/replication-semisync-installation.html shows the possible values of rpl_semi_sync_master_enabled and rpl_semi_sync_slave_enabled as being 0 and 1.

When displaying the variables OFF and ON are used. While it is possible to use 0 & 1 when setting the value, you'll then be shown the results as OFF and ON which is confusing.

master> show variables like 'rpl_semi_sync_master_enabled';
+------------------------------+-------+
| Variable_name                | Value |
+------------------------------+-------+
| rpl_semi_sync_master_enabled | ON    |
+------------------------------+-------+

slave> show variables like 'rpl_semi_sync_slave_enabled';
+-----------------------------+-------+
| Variable_name               | Value |
+-----------------------------+-------+
| rpl_semi_sync_slave_enabled | ON    |
+-----------------------------+-------+

0 & 1 are also used at http://dev.mysql.com/doc/refman/5.5/en/server-system-variables.html#sysvar_rpl_semi_sync_m... and http://dev.mysql.com/doc/refman/5.5/en/server-system-variables.html#sysvar_rpl_semi_sync_s...

Similar problem with the status variable Rpl_semi_sync_master_status where the documentation at http://dev.mysql.com/doc/refman/5.5/en/server-status-variables.html#statvar_Rpl_semi_sync_... indicates 0 & 1 but it's actually OFF & ON that are displayed....

master> SHOW STATUS LIKE 'Rpl_semi_sync_master_status';
+-----------------------------+-------+
| Variable_name               | Value |
+-----------------------------+-------+
| Rpl_semi_sync_master_status | ON    |
+-----------------------------+-------+

Same problem for Rpl_semi_sync_slave_status

How to repeat:
master> show variables like 'rpl_semi_sync_master_enabled';

slave> show variables like 'rpl_semi_sync_slave_enabled';

Suggested fix:
Documentation should match what the user will see from the command line.
[30 Sep 2010 10:00] Valeriy Kravchuk
These variables should be explicitly described as "boolean" at least, on pages like http://dev.mysql.com/doc/refman/5.5/en/server-system-variables.html#sysvar_rpl_semi_sync_s...
[30 Sep 2010 23:03] Paul DuBois
Thank you for your bug report. This issue has been addressed in the documentation. The updated documentation will appear on our website shortly, and will be included in the next release of the relevant products.