--help does not work as advertised

Bug #546190 reported by ntucker
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
MySQL Sandbox
Confirmed
Undecided
Unassigned

Bug Description

The documentation (http://search.cpan.org/~gmax/MySQL-Sandbox-3.0.06/lib/MySQL/Sandbox.pm) does not document all the options available to the scripts, but instead says, 'Every sandbox script will give you additional information if you invoke it with the "--help" option.' This is far from true. For example, 'make_sandbox --help' only lists one single option (--export_binaries).

Ok, I guess it is technically true that it gave "additional information" but it's not very helpful. ;)

Also very helpful would be some documentation on what the various convenience scripts actually do. I would, for example, like to combine the make_sandbox_from_installed functionality with make_replication_sandbox but don't know what options to pass to the low level sandbox maker in order to make that happen. Some docs along the lines of "make_replication_sandbox is equivalent to make_sandbox with the following options: ..." would really help.

Changed in mysql-sandbox:
status: New → Confirmed
Revision history for this message
Giuseppe Maxia (giuseppe-maxia) wrote :

Thanks for this bug report.

make_sandbox_from_installed lacks a proper help. You can see the options in the manual. I will add a help in the next release.

As for make_sandbox, The only option accepted by make_sandbox itself is --export_binaries. The help says that you can also use any option listed for low_level_make_sandbox. You can see the help for that utility for details, or read the manual.

FYI, make_sandbox_from_installed doesn't support replication. As yourself have note in another bug report, the script is quite fragile also for a single sandbox. I haven't planned further work on that script, but I will accept patches.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.