Bug #32408 mysqldump: Incorrect --help text
Submitted: 15 Nov 2007 14:26 Modified: 18 Jun 2009 15:01
Reporter: Paul DuBois Email Updates:
Status: Closed Impact on me:
None 
Category:MySQL Server: mysqldump Command-line Client Severity:S3 (Non-critical)
Version:4.1 and up OS:Any
Assigned to: Jim Winstead CPU Architecture:Any

[15 Nov 2007 14:26] Paul DuBois
Description:
The --help text for some mysqldump options is incomplete or incorrect.

1) --compact disables comments, but its help text does not say that it enables --skip-comments. The text should add --skip-comments to the list of options that --compact enables. You can see that --skip-comments is enabled from this code:

  case (int) OPT_COMPACT:
  if (opt_compact)
  {
    opt_comments= opt_drop= opt_disable_keys= opt_lock= 0;
    opt_set_charset= 0;
  }

2) The help text for --compact also refers to an obsolete option. It says that --compact enables --no-set-names, which is deprecated. It should say --skip-set-charset instead.

How to repeat:
Examine the code

Suggested fix:
Something like this:

===== mysqldump.c 1.206 vs edited =====
--- 1.206/client/mysqldump.c    2007-10-04 01:27:01 -05:00
+++ edited/mysqldump.c  2007-11-15 08:24:49 -06:00
@@ -179,7 +179,7 @@
    (gptr*) &opt_compatible_mode_str, (gptr*) &opt_compatible_mode_str, 0,
    GET_STR, REQUIRED_ARG, 0, 0, 0, 0, 0, 0},
   {"compact", OPT_COMPACT,
-   "Give less verbose output (useful for debugging). Disables structure comments and header/footer constructs.  Enables options --skip-add-drop-table --no-set-names --skip-disable-keys --skip-add-locks",
+   "Give less verbose output (useful for debugging). Disables structure comments and header/footer constructs.  Enables options --skip-add-drop-table --skip-comments --skip-set-charset --skip-disable-keys --skip-add-locks",
    (gptr*) &opt_compact, (gptr*) &opt_compact, 0, GET_BOOL, NO_ARG, 0, 0, 0, 0,
    0, 0},
   {"complete-insert", 'c', "Use complete insert statements.",

It might be better to list the options in lexical order, though.

By the way, I have no idea what "structure comments" or "header/footer constructs" are.
[15 Nov 2007 15:20] Valeriy Kravchuk
Thank you for a bug report.
[28 Apr 2009 18:24] Bugs System
A patch for this bug has been committed. After review, it may
be pushed to the relevant source trees for release in the next
version. You can access the patch from:

  http://lists.mysql.com/commits/72938

2880 Jim Winstead	2009-04-28
      Fix list of options enabled by mysqldump --compact (Bug #32408)
      modified:
        client/mysqldump.c
[5 May 2009 18:03] Jim Winstead
Queued to 5.1-bugteam and 6.0-bugteam.
[28 May 2009 8:17] Bugs System
Pushed into 5.1.36 (revid:joro@sun.com-20090528073639-yohsb4q1jzg7ycws) (version source revid:mats@sun.com-20090511132802-nnkiyb2huih1tklz) (merge vers: 5.1.35) (pib:6)
[29 May 2009 1:23] Paul DuBois
Cosmetic change. No changelog entry needed.

Setting report to NDI pending push into 6.0.x.
[17 Jun 2009 19:25] Bugs System
Pushed into 5.4.4-alpha (revid:alik@sun.com-20090616183122-chjzbaa30qopdra9) (version source revid:jimw@mysql.com-20090505173706-9ze3q4qzngw8kt2b) (merge vers: 6.0.12-alpha) (pib:11)
[18 Jun 2009 15:01] Paul DuBois
Cosmetic change. No changelog entry needed.
[26 Aug 2009 13:46] Bugs System
Pushed into 5.1.37-ndb-7.0.8 (revid:jonas@mysql.com-20090826132541-yablppc59e3yb54l) (version source revid:jonas@mysql.com-20090826132541-yablppc59e3yb54l) (merge vers: 5.1.37-ndb-7.0.8) (pib:11)
[26 Aug 2009 13:46] Bugs System
Pushed into 5.1.37-ndb-6.3.27 (revid:jonas@mysql.com-20090826105955-bkj027t47gfbamnc) (version source revid:jonas@mysql.com-20090826105955-bkj027t47gfbamnc) (merge vers: 5.1.37-ndb-6.3.27) (pib:11)
[26 Aug 2009 13:48] Bugs System
Pushed into 5.1.37-ndb-6.2.19 (revid:jonas@mysql.com-20090825194404-37rtosk049t9koc4) (version source revid:jonas@mysql.com-20090825194404-37rtosk049t9koc4) (merge vers: 5.1.37-ndb-6.2.19) (pib:11)
[27 Aug 2009 16:33] Bugs System
Pushed into 5.1.35-ndb-7.1.0 (revid:magnus.blaudd@sun.com-20090827163030-6o3kk6r2oua159hr) (version source revid:jonas@mysql.com-20090826132541-yablppc59e3yb54l) (merge vers: 5.1.37-ndb-7.0.8) (pib:11)