[tahoe-lafs-trac-stream] [Tahoe-LAFS] #2233: CLI: 'tahoe $SUBCOMMAND --help' no longer shows "global" options

Tahoe-LAFS trac at tahoe-lafs.org
Mon May 4 08:26:31 UTC 2015


#2233: CLI: 'tahoe $SUBCOMMAND --help' no longer shows "global" options
--------------------------+------------------------------------------------
     Reporter:  daira     |      Owner:  warner
         Type:  defect    |     Status:  new
     Priority:  normal    |  Milestone:  1.10.1
    Component:  code-     |    Version:  1.10.0
  frontend-cli            |   Keywords:  cli regression usability docs help
   Resolution:            |
Launchpad Bug:            |
--------------------------+------------------------------------------------

Comment (by warner):

 Hm, does it really need to do this? I think that could get a bit noisy, to
 have those same global opts on every command. Git doesn't do it that way.

 How about a single line that points to `tahoe --help` to get the global
 options, like:

 {{{
 $ bin/tahoe start --help
 Usage:  tahoe [global-opts] start [options] [NODEDIR]
 (use 'tahoe --help' to view global options)

 Options:
   -p, --profile   Run under the Python profiler, putting results in
                   'profiling_results.prof'.
       --syslog    Tell the node to log to syslog, not a file.
   -C, --basedir=  Same as --node-directory.
       --version
       --help      Display this help and exit.
 }}}

 but maybe we inline the global-opts on just the `create-*` subcommands, to
 emphasize how `-d` is different there:

 {{{
 $ ./bin/tahoe create-node --help
 Usage: tahoe [global-opts] create-node [options] [NODEDIR]

 Global options:
   -q, --quiet             Operate silently.
   -V, --version           Display version numbers.
       --version-and-path  Display version numbers and paths to their
 locations.
   -d, --node-directory=   Specify an empty directory to be used for the
 new
                           Tahoe node.
       --help              Display this help and exit.

 Options:
       --no-storage   Do not offer storage service to other nodes.
   -C, --basedir=     Specify which Tahoe base directory should be used.
                      [default: '/Users/warner/.tahoe']
   -n, --nickname=    Specify the nickname for this node.
   -i, --introducer=  Specify the introducer FURL to use.
   -p, --webport=     Specify which TCP port to run the HTTP interface on.
 Use
                      'none' to disable. [default:
 tcp:3456:interface=127.0.0.1]
       --version
       --help         Display this help and exit.
 }}}

--
Ticket URL: <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/2233#comment:6>
Tahoe-LAFS <https://Tahoe-LAFS.org>
secure decentralized storage


More information about the tahoe-lafs-trac-stream mailing list