search

hugowan / maatkit

Automatically exported from code.google.com/p/maatkit
0 stars 0 forks source link

mk-archiver Documentation: document nochkcols #140

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
Purely a documentation bug - currently we have:

"""
--chkcols
    Enabled by default; causes mk-archiver to check that the source and
destination tables have the same columns. It does not check column order,
data type, etc. It just checks that all columns in the source exist in the
destination and vice versa. If there are any differences, mk-archiver will
exit with an error. 
"""

chkcols is enabled by default, so adding this option does nothing. What a
user may want to do is disable this check, but the docs provide no way to
do that.

Having checked the source, I found the option nochkcols, which was very
useful for me. It would be great if we could mention it in the docs, unless
it's not officially supported or something?

Suggested changes:
"""
--chkcols
    Enabled by default; causes mk-archiver to check that the source and
destination tables have the same columns. It does not check column order,
data type, etc. It just checks that all columns in the source exist in the
destination and vice versa. If there are any differences, mk-archiver will
exit with an error. To disable this check, use "--nochkcols".

...
--nochkcols
    Disables the check described in "--nochkcols".
"""

Original issue reported on code.google.com by dpcah...@gmail.com on 2 Dec 2008 at 1:18

GoogleCodeExporter commented 9 years ago 
Thanks for the bug report.

It's pretty standard for Unix command-line conventions to allow --no in front of
optional arguments, and not necessarily document them as separate arguments.  
There
are other conventions too.  For example, a lot of the mysql command-line tools 
accept
--skip[foo].

The --help documentation in the Maatkit tools already shows the optional --no in
brackets.  It is generated on-the-fly from the POD, and I am thinking that the 
POD
should show the same magical syntax with [no] in the option.

Original comment by baron.schwartz on 10 Dec 2008 at 5:43

GoogleCodeExporter commented 9 years ago

Original comment by dan...@percona.com on 12 Dec 2008 at 4:51

GoogleCodeExporter commented 9 years ago 
Target these for release end of January 2009.

Original comment by baron.schwartz on 4 Jan 2009 at 5:04

GoogleCodeExporter commented 9 years ago 
Here's the change I want to see:

The POD syntax is currently this:

=item --foo

negatable: yes;.....

I want it to be this instead:

=item --[no]foo

Original comment by baron.schwartz on 4 Jan 2009 at 5:08

GoogleCodeExporter commented 9 years ago 
I'm working on this. OptionParser will need to be changed of course, because
currently it dies on =item --[no]foo.

Original comment by dan...@percona.com on 16 Jan 2009 at 9:03

GoogleCodeExporter commented 9 years ago 
OptionParser updated in r2825.

Original comment by dan...@percona.com on 16 Jan 2009 at 9:27

GoogleCodeExporter commented 9 years ago 
I'm working on updating mk-archiver to use pod_to_spec.

Original comment by dan...@percona.com on 16 Jan 2009 at 10:05

GoogleCodeExporter commented 9 years ago 
mk-archiver has been updated as of r2827.

Original comment by dan...@percona.com on 17 Jan 2009 at 6:12

GoogleCodeExporter commented 9 years ago 
All scripts which had "negatable: yes" have been updated and tested.

Original comment by dan...@percona.com on 17 Jan 2009 at 9:10