tahoe-lafs/trac-2024-07-25
2
0
Issues 1.1k Wiki

CLI: 'tahoe $SUBCOMMAND --help' no longer shows "global" options #2233

New Issue
Closed
opened 2014-04-24 17:07:49 +00:00 by daira · 9 comments
daira commented 2014-04-24 17:07:49 +00:00
Owner
Copy Link

For example, in Tahoe-LAFS v1.9.2:

$ bin/tahoe start --help
Usage:  tahoe start [options] [NODEDIR]
Options:
  -q, --quiet             Operate silently.
  -V, --version           Display version numbers.
      --version-and-path  Display version numbers and paths to their locations.
  -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.
  -d, --node-directory=   Specify which Tahoe node directory should be used.
                          [default for most commands: 'REDACTED']
      --help              Display this help and exit.

In Tahoe-LAFS v1.10.0:

$ bin/tahoe start --help
Usage:  tahoe [global-opts] start [options] [NODEDIR]
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 (default REDACTED).
      --version   
      --help      Display this help and exit.

This appears to be a regression due to the fix for #166.

For example, in Tahoe-LAFS v1.9.2: ``` $ bin/tahoe start --help Usage: tahoe start [options] [NODEDIR] Options: -q, --quiet Operate silently. -V, --version Display version numbers. --version-and-path Display version numbers and paths to their locations. -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. -d, --node-directory= Specify which Tahoe node directory should be used. [default for most commands: 'REDACTED'] --help Display this help and exit. ``` In Tahoe-LAFS v1.10.0: ``` $ bin/tahoe start --help Usage: tahoe [global-opts] start [options] [NODEDIR] 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 (default REDACTED). --version --help Display this help and exit. ``` This appears to be a regression due to the fix for #166.
tahoe-lafs added the
code-frontend-cli
normal
defect
1.10.0
 labels 2014-04-24 17:07:49 +00:00
tahoe-lafs added this to the soon milestone 2014-04-24 17:07:49 +00:00
daira commented 2014-04-24 17:17:07 +00:00
Author
Owner
Copy Link

The desired output is:

$ bin/tahoe start --help
Usage:  tahoe [global-opts] start [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 which Tahoe node directory should be used. The
                          directory should either contain a full Tahoe node, or
                          a file named node.url that points to some other Tahoe
                          node. It should also contain a file named
                          'private/aliases' which contains the mapping from
                          alias name to root dirnode URI. [default for most
                          commands: 'REDACTED']
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.

Notice that the desired description of -d for create-* subcommands should be different:

  -d, --node-directory=   Specify an empty directory to be used for the new Tahoe node.

Also note that this has a default in the case of tahoe create-node and tahoe create-client, but not for tahoe create-key-generator or tahoe create-stats-gatherer.

The desired output is: ``` $ bin/tahoe start --help Usage: tahoe [global-opts] start [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 which Tahoe node directory should be used. The directory should either contain a full Tahoe node, or a file named node.url that points to some other Tahoe node. It should also contain a file named 'private/aliases' which contains the mapping from alias name to root dirnode URI. [default for most commands: 'REDACTED'] 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. ``` Notice that the desired description of `-d` for `create-*` subcommands should be different: ``` -d, --node-directory= Specify an empty directory to be used for the new Tahoe node. ``` Also note that this has a default in the case of `tahoe create-node` and `tahoe create-client`, but not for `tahoe create-key-generator` or `tahoe create-stats-gatherer`.
tahoe-lafs modified the milestone from soon to 1.10.1 2015-04-12 23:02:24 +00:00
daira commented 2015-04-14 16:40:00 +00:00
Author
Owner
Copy Link

This is not a blocker for 1.10.1, just a nice-to-have.

This is not a blocker for 1.10.1, just a nice-to-have.
warner commented 2015-05-04 08:26:29 +00:00
Copy Link

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.
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. ```
daira commented 2015-05-09 23:46:36 +00:00
Author
Owner
Copy Link

Hmm. The description "Same as --node-directory." for -C doesn't make sense unless --node-directory is described. I think I'd prefer it as it is in comment:94981, TBH.

Hmm. The description "`Same as --node-directory.`" for `-C` doesn't make sense unless `--node-directory` is described. I think I'd prefer it as it is in [comment:94981](/tahoe-lafs/trac-2024-07-25/issues/2233#issuecomment-94981), TBH.
warner commented 2015-05-12 16:55:38 +00:00
Copy Link

What it we removed that "same as" reference?:

$ 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=  Specify which Tahoe base directory should be used.
                  [default: '/Users/warner/.tahoe']. Overrides any
                  global --basedir option.
      --version   
      --help      Display this help and exit.
What it we removed that "same as" reference?: ``` $ 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= Specify which Tahoe base directory should be used. [default: '/Users/warner/.tahoe']. Overrides any global --basedir option. --version --help Display this help and exit. ```
daira commented 2015-05-13 14:53:41 +00:00
Author
Owner
Copy Link

It is not the case that --basedir= overrides --node-directory=; only one may be present.

Better would be:

$ 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=  Specify which Tahoe base directory should be used.
                  [default: '/Users/warner/.tahoe']. This has the same
                  effect as the global --node-directory option.
      --version   
      --help      Display this help and exit.
It is not the case that `--basedir=` overrides `--node-directory=`; only one may be present. Better would be: ``` $ 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= Specify which Tahoe base directory should be used. [default: '/Users/warner/.tahoe']. This has the same effect as the global --node-directory option. --version --help Display this help and exit. ```
warner commented 2015-05-26 15:51:56 +00:00
Copy Link

PR ready for review in https://github.com/tahoe-lafs/tahoe-lafs/pull/168

PR ready for review in <https://github.com/tahoe-lafs/tahoe-lafs/pull/168>
daira commented 2015-05-26 17:59:51 +00:00
Author
Owner
Copy Link

LGTM.

LGTM.
Brian Warner <warner@lothar.com> commented 2015-05-26 20:24:12 +00:00
Author
Owner
Copy Link

In /tahoe-lafs/trac-2024-07-25/commit/9d6003357da3eab8106269a022f4a615d52b0f8b:

Merge branch 'globalopts2'

Improves CLI rendering of --help for global options. Closes ticket:2233.
In [/tahoe-lafs/trac-2024-07-25/commit/9d6003357da3eab8106269a022f4a615d52b0f8b](/tahoe-lafs/trac-2024-07-25/commit/9d6003357da3eab8106269a022f4a615d52b0f8b): ``` Merge branch 'globalopts2' Improves CLI rendering of --help for global options. Closes ticket:2233. ```
tahoe-lafs added the
fixed
 label 2015-05-26 20:24:12 +00:00
Brian Warner <warner@lothar.com> closed this issue 2015-05-26 20:24:12 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels   
0.2.0

   
0.3.0

   
0.4.0

   
0.5.0

   
0.5.1

   
0.6.0

   
0.6.1

   
0.7.0

   
0.8.0

   
0.9.0

   
1.0.0

   
1.1.0

   
1.10.0

   
1.10.1

   
1.10.2

   
1.10a2

   
1.11.0

   
1.12.0

   
1.12.1

   
1.13.0

   
1.14.0

   
1.15.0

   
1.15.1

   
1.2.0

   
1.3.0

   
1.4.1

   
1.5.0

   
1.6.0

   
1.6.1

   
1.7.0

   
1.7.1

   
1.7β

   
1.8.0

   
1.8.1

   
1.8.2

   
1.8.3

   
1.8β

   
1.9.0

   
1.9.0-s3branch

   
1.9.0a1

   
1.9.0a2

   
1.9.0b1

   
1.9.1

   
1.9.2

   
1.9.2a1

   
LeastAuthority.com automation

   
blocker

   
cannot reproduce

   
cloud-branch

   
code

catch-all for anything that can be fixed by writing code but isn't classified better

  
code-dirnodes

anything involving tahoe directories

  
code-encoding

immutable-file encoding format/layout, cap format, encoding/decoding algorithms

  
code-frontend

general frontend things: new user-facing interfaces, FTP/SFTP servers, FUSE-like interfaces

  
code-frontend-cli

CLI tools

  
code-frontend-ftp-sftp

   
code-frontend-magic-folder

   
code-frontend-web

webapi interfaces, user-facing "WUI" interfaces

  
code-mutable

anything involving mutable files: encoding/decoding, share format

  
code-network

Introducer, locating storage servers, establishing/maintaining connections to them

  
code-nodeadmin

node startup/shutdown, tools to create nodes, logging tools, management/monitoring tools, manhole, disk-space-limiting tools

  
code-peerselection

server selection/sorting algorithm, rebalancing code, allocation policy, swarming-download

  
code-storage

storage-server implementation, share-storage directory layout, client-to-server share transfer protocol

  
contrib

problems with non-core things that live in the source:contrib/ directory

  
critical

   
defect

   
dev-infrastructure

things that help us build Tahoe: buildbot, automated speed/memory/code-coverage tests and results-displayers, IRC channels, mailing lists, this Trac instance

  
documentation

docs items. Also use 'docs' keyword on tickets in more specific components.

  
duplicate

   
enhancement

   
fixed

   
invalid

   
major

   
minor

   
n/a

   
normal

   
operational

things involved in running a tahoe grid, external tools to monitor/maintain a grid (like "nodeadmin" but larger-scale). Was also used for issues with the allmydata.com grid.

  
packaging

setup.py script, library dependencies, binary packages, licensing, installation instructions

  
somebody else's problem

   
supercritical

   
task

   
trivial

   
unknown

Uncategorized. All tickets default to this component until someone updates it.

  
was already fixed

   
website

things about the tahoe-lafs.org website (and sometimes this Trac instance, shared with 'dev-infrastructure')

  
wontfix

   
worksforme
No Label
0.2.0
0.3.0
0.4.0
0.5.0
0.5.1
0.6.0
0.6.1
0.7.0
0.8.0
0.9.0
1.0.0
1.1.0
1.10.0
1.10.1
1.10.2
1.10a2
1.11.0
1.12.0
1.12.1
1.13.0
1.14.0
1.15.0
1.15.1
1.2.0
1.3.0
1.4.1
1.5.0
1.6.0
1.6.1
1.7.0
1.7.1
1.7β
1.8.0
1.8.1
1.8.2
1.8.3
1.8β
1.9.0
1.9.0-s3branch
1.9.0a1
1.9.0a2
1.9.0b1
1.9.1
1.9.2
1.9.2a1
LeastAuthority.com automation
blocker
cannot reproduce
cloud-branch
code
code-dirnodes
code-encoding
code-frontend
code-frontend-cli
code-frontend-ftp-sftp
code-frontend-magic-folder
code-frontend-web
code-mutable
code-network
code-nodeadmin
code-peerselection
code-storage
contrib
critical
defect
dev-infrastructure
documentation
duplicate
enhancement
fixed
invalid
major
minor
n/a
normal
operational
packaging
somebody else's problem
supercritical
task
trivial
unknown
was already fixed
website
wontfix
worksforme
Milestone
Clear milestone
No items
No Milestone
1.10.1
Assignees
Clear assignees
No Assignees
warner
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Reference: tahoe-lafs/trac-2024-07-25#2233
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?