tahoe-lafs/trac-2024-07-25

Incorrect subcommand name in 'magic-folder --help' text #2878

New issue

Closed

opened 2017-06-22 05:37:29 +00:00 by cypher · 1 comment

cypher commented

2017-06-22 05:37:29 +00:00

Owner

This is a very minor issue but still one worth reporting. :)

tahoe magic-folder --help displays the following output:

Usage: tahoe [global-options] magic SUBCOMMAND
(use 'tahoe --help' to view global options)

Options:
  -d, --debug    Print full stack-traces
      --version  
      --help     Display this help and exit.
Commands:
    create      Create a Magic Folder.
    invite      Invite someone to a Magic Folder.
    join        Join a Magic Folder.
    leave       Leave a Magic Folder.
    status      Display status of uploads/downloads.
Please run e.g. 'tahoe magic-folder create --help' for more details on each
subcommand.

However, there exists no magic subcommand; running, e.g., tahoe magic --help returns the standard help output (with the accompanying error message Unknown command: magic). Accordingly, magic should either be aliased to magic-folder or corrected in the help text itself.

This is a very minor issue but still one worth reporting. :) `tahoe magic-folder --help` displays the following output: ``` Usage: tahoe [global-options] magic SUBCOMMAND (use 'tahoe --help' to view global options) Options: -d, --debug Print full stack-traces --version --help Display this help and exit. Commands: create Create a Magic Folder. invite Invite someone to a Magic Folder. join Join a Magic Folder. leave Leave a Magic Folder. status Display status of uploads/downloads. Please run e.g. 'tahoe magic-folder create --help' for more details on each subcommand. ``` However, there exists no `magic` subcommand; running, e.g., `tahoe magic --help` returns the standard help output (with the accompanying error message `Unknown command: magic`). Accordingly, `magic` should either be aliased to `magic-folder` or corrected in the help text itself.

tahoe-lafs added the

labels 2017-06-22 05:37:29 +00:00

tahoe-lafs added this to the undecided milestone 2017-06-22 05:37:29 +00:00

hf commented

2017-12-31 13:37:40 +00:00

Author

Owner

This issues seems to be fixed.

% tahoe magic-folder --help        
Usage: tahoe [global-options] magic-folder
(use 'tahoe --help' to view global options)

Options:
  -d, --debug    Print full stack-traces
      --help     Display this help and exit.
      --version  
Commands:
    create      Create a Magic Folder.
    invite      Invite someone to a Magic Folder.
    join        Join a Magic Folder.
    leave       Leave a Magic Folder.
    list        List Magic Folders configured in this client.
    status      Display status of uploads/downloads.
Please run e.g. 'tahoe magic-folder create --help' for more details on each subcommand.

A magic-folder has an owner who controls the writecap containing a list of
nicknames and readcaps. The owner can invite new participants. Every participant
has the writecap for their own folder (the corresponding readcap is in the
master folder). All clients download files from all other participants using the
readcaps contained in the master magic-folder directory.

% tahoe --version             
tahoe-lafs: 1.12.1.post169 [master: 5e62118e14dda4999ac62eb1d802b568c4c23189]

Grepping the source for "tahoe magic " also did not turn up anything.

This issues seems to be fixed. ``` % tahoe magic-folder --help Usage: tahoe [global-options] magic-folder (use 'tahoe --help' to view global options) Options: -d, --debug Print full stack-traces --help Display this help and exit. --version Commands: create Create a Magic Folder. invite Invite someone to a Magic Folder. join Join a Magic Folder. leave Leave a Magic Folder. list List Magic Folders configured in this client. status Display status of uploads/downloads. Please run e.g. 'tahoe magic-folder create --help' for more details on each subcommand. A magic-folder has an owner who controls the writecap containing a list of nicknames and readcaps. The owner can invite new participants. Every participant has the writecap for their own folder (the corresponding readcap is in the master folder). All clients download files from all other participants using the readcaps contained in the master magic-folder directory. % tahoe --version tahoe-lafs: 1.12.1.post169 [master: 5e62118e14dda4999ac62eb1d802b568c4c23189] ``` Grepping the source for "tahoe magic " also did not turn up anything.

tahoe-lafs added the

was already fixed

label 2017-12-31 13:37:40 +00:00

hf closed this issue

2017-12-31 13:37:40 +00:00