Bug #56778 Documentation: mysqlbinlog --help entry for -s not consistent with the manual
Submitted: 14 Sep 2010 18:38 Modified: 23 Sep 2010 22:39
Reporter: Leandro Morgado Email Updates:
Status: Closed Impact on me:
None 
Category:MySQL Server: Documentation Severity:S4 (Feature request)
Version:5.1 OS:Any
Assigned to: Paul DuBois CPU Architecture:Any

[14 Sep 2010 18:38] Leandro Morgado
Description:
The documentation for mysqlbinlog short-format option is not consistent, as in the --help it says it's not fit for production but in the manual there is no such warning. 

How to repeat:
shell> mysqlbinlog --version
mysqlbinlog Ver 3.3 for apple-darwin10.3.0 at i386

shell> mysqlbinlog --help | grep -A4 "\-\-short-form"
  -s, --short-form    Just show regular queries: no extra info and no row-based
                      events. This is for testing only, and should not be used
                      in production systems. If you want to suppress
                      base64-output, consider using --base64-output=never
                      instead.

"--short-form, -s

Display only the statements contained in the log, without any extra information."
  http://dev.mysql.com/doc/refman/5.1/en/mysqlbinlog.html#option_mysqlbinlog_short-form

Suggested fix:
Fix one of the entries, either removing the warning in the --help or adding it in the manual.
[23 Sep 2010 22:39] 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.

I updated the description in the manual to be consistent with the --help message.