Bug #22282 mysqldump should document --option=0 [with patch]
Submitted: 12 Sep 2006 19:54 Modified: 4 Oct 2006 17:47
Reporter: Christian Hammers (Silver Quality Contributor) (OCA) Email Updates:
Status: Closed Impact on me:
None 
Category:MySQL Server: Documentation Severity:S3 (Non-critical)
Version:all OS:
Assigned to: Paul DuBois CPU Architecture:Any

[12 Sep 2006 19:54] Christian Hammers 
Description:
Several times now, Debian users mailed me complaining that they don't know how disable this "new" output format (meaning "extended-insert") which is unintended when the output should be edited with sed or by hand. So I wrote a small patch
to the manpage.

How to repeat:
man mysqldump

Suggested fix:
--- mysqldump.1 2006-08-24 18:15:37.000000000 +0200
+++ mysqldump.1.edited  2006-09-12 21:50:22.000000000 +0200
@@ -45,7 +45,8 @@
 To get a list of the options your version of
 \fBmysqldump\fR
 supports, execute
-\fBmysqldump \-\-help\fR.
+\fBmysqldump \-\-help\fR. You can disable options with 
+e.g. \fB\-\-extended\-insert=0\fR.
 .PP
 If you run
 \fBmysqldump\fR
[12 Sep 2006 20:00] Paul DuBois 
Is this a report pertaining to the documentation, or
to the --help message that mysqldump prints?
[12 Sep 2006 21:23] Christian Hammers 
Hi

As you can see at the patch it is obviously regarding the manpage/documentation :)

BTW: the --help output explains that "--option=[true|false]". So my patch should better say "--extended-insert=false" instead of "--extended-insert=0". This is easier to remember anyway.

bye,

-christian-
[12 Sep 2006 23:09] Paul DuBois 
This is a docs issue, not a program issue. Resetting
category and assigning to myself.
[22 Sep 2006 18:32] Sergei Golubchik 
I thought it's already documented that any boolean option can be turned off with any one of

  --skip-option
  --disable-option
  --option=0
[22 Sep 2006 18:36] Paul DuBois 
Serg, that's true, but with respect to mysqldump in particular,
the change in default behavior and how to use --skip to get
what you want needs to be made clearer.
[4 Oct 2006 17:47] 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.

What I've done here is to add some discussion at the beginning of the mysqldump
section to indicate that some options affect groups of other options, points out
their --skip forms, and illustrates how to enable/disable certain aspects of
the group options.