MySQL Bugs: #114786: Inaccurate documentation for '--compatible' command line option of mysqldump

Bug #114786	Inaccurate documentation for '--compatible' command line option of mysqldump
Submitted:	25 Apr 2024 12:44	Modified:	27 Nov 16:43
Reporter:	Nikita Radchenko	Email Updates:
Status:	Closed	Impact on me:	None
Category:	MySQL Server: Command-line Clients	Severity:	S3 (Non-critical)
Version:	ALL	OS:	Any
Assigned to:		CPU Architecture:	Any

Description:
1. For 5.7, the explanation mentions 'no_key_options and 'no_field_options' as valid values for '--compatible'; however, the "Valid Values" table row doesn't list the latter at all, but lists 'no_key_options' twice.
2. For 8.0, the explanation mentions 'ansi' as the only valid value for '--compatible'; however, the table lists the same erroneous list of options as for 5.7.

How to repeat:
1. https://dev.mysql.com/doc/refman/5.7/en/mysqldump.html#option_mysqldump_compatible
2. https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html#option_mysqldump_compatible
3. mysqldump man page

Suggested fix:
Fix the documentation so it describes actual valid values for the option. Probably some other options are described wrong too, and also should be fixed.

Hi Mr. Radchenko,

Thank you for your documentation bug report.

Since 5.7 is no longer maintained, this is now a verified documentation bug for 8.0 and above.

--help output for "compatible" from 8.4 mysqldump:

  --compatible=name   Change the dump to be compatible with a given mode. By
                      default tables are dumped in a format optimized for
                      MySQL. The only legal mode is ANSI.Note: Requires MySQL
                      server version 4.1.0 or higher. This option is ignored
                      with earlier server versions.

This appears to be old/wrong and needs to be fixed. When this is fixed and put in Documenting, please make it clear to Docs where current/correct info can be found about valid values. Thanks!

Thank you, Jon.

Posted by developer:
 
The text printed by the --help option is neither obsolete nor incorrect. 

ANSI is the only supported mode indeed. And it does require 4.1 or higher. 

Moving to a docs bug.

Documentation updated as requested. ansi is the only legal value for 
--compatible.
Thank you for the bug report.