Missing options information #715

New Issue

tahoe-lafs · 2009-05-28T03:39:45Z

bewst commented

2009-05-28 03:39:45 +00:00

I think the --help and especially the online docs for the tahoe command are way too lean. There's not even any documentation I can find of the --base-dir option; I had to crawl the code for it!

Note: if the docs were in the wiki, I'd have made that correction myself.

I think the `--help` and especially the online docs for the tahoe command are way too lean. There's not even any documentation I can find of the `--base-dir` option; I had to crawl the code for it! Note: if the docs were in the wiki, I'd have made that correction myself.

tahoe-lafs added the

labels 2009-05-28 03:39:45 +00:00

tahoe-lafs added this to the undecided milestone 2009-05-28 03:39:45 +00:00

davidsarah commented

2009-12-04 05:37:41 +00:00

See also #742 (about tahoe cp --help).

See also #742 (about `tahoe cp --help`).

tahoe-lafs added

code-frontend-cli

and removed

documentation

labels 2009-12-04 05:37:41 +00:00

tahoe-lafs modified the milestone from undecided to 1.6.0

2009-12-04 05:37:41 +00:00

davidsarah commented

2010-01-10 03:48:36 +00:00

Oops, that change breaks the checking that --basedir is provided for subcommands that have no default basedir. Please ignore while I fix it.

Oops, that change breaks the checking that `--basedir` is provided for subcommands that have no default basedir. Please ignore while I fix it.

davidsarah commented

2010-01-10 05:28:20 +00:00

No unit tests for the change to basedir behaviour yet.

davidsarah commented

2010-01-10 06:05:31 +00:00

The diff also implements #890.

davidsarah commented

2010-01-10 06:07:56 +00:00

Sample of new options text:

$ tahoe --help
Usage:  tahoe <command> [command options]
Options:
  -q, --quiet             Operate silently.
  -V, --version           Display version numbers and exit.
      --version-and-path  Display version numbers and paths to their locations
                          and exit.
  -C, --basedir=          Specify the base directory of the node to be used.
                          [default for most commands: C:\Users\David/.tahoe]
      --help              Display this help and exit.

Sample of new options text: ``` $ tahoe --help Usage: tahoe <command> [command options] Options: -q, --quiet Operate silently. -V, --version Display version numbers and exit. --version-and-path Display version numbers and paths to their locations and exit. -C, --basedir= Specify the base directory of the node to be used. [default for most commands: C:\Users\David/.tahoe] --help Display this help and exit. ```

terrell commented

2010-01-12 00:36:43 +00:00

there is a forward slash in the sample above ( \David/.tahoe )

davidsarah commented

2010-01-12 04:55:24 +00:00

Attachment common.py_diff.txt (4675 bytes) added

Diff for source:src/allmydata/scripts/common.py to show --basedir option with absolute path for default basedir

**Attachment** common.py_diff.txt (4675 bytes) added Diff for source:src/allmydata/scripts/common.py to show --basedir option with absolute path for default basedir

common.py_diff.txt

4.6 KiB

davidsarah commented

2010-01-12 04:56:41 +00:00

Replying to terrell:

there is a forward slash in the sample above ( \David/.tahoe )

Fixed. But I want to fix #188 and #706 as well, and add unit tests, so this isn't ready for review yet.

Replying to [terrell](/tahoe-lafs/trac-2024-07-25/issues/715#issuecomment-71302): > there is a forward slash in the sample above ( \David/.tahoe ) Fixed. But I want to fix #188 and #706 as well, and add unit tests, so this isn't ready for review yet.

zooko modified the milestone from 1.6.0 to eventually

2010-01-26 15:43:59 +00:00

tahoe-lafs modified the milestone from eventually to 1.7.0

2010-02-01 19:42:48 +00:00

davidsarah commented

2010-03-13 00:24:03 +00:00

I'll modify the patch to also show in the help how the basedir is arrived at, thus fixing #985.

zooko commented

2010-05-08 20:47:02 +00:00

Is this ticket ready for review?

tahoe-lafs modified the milestone from 1.7.0 to 1.7.1

2010-06-12 20:55:50 +00:00

tahoe-lafs modified the milestone from 1.7.1 to 1.8β

2010-07-17 03:56:15 +00:00

davidsarah commented

2010-07-22 01:07:56 +00:00

Attachment basedir-option-improvements.dpatch (19998 bytes) added

Basedir/node directory option improvements. addresses #188, #706, #715, #772, #890

**Attachment** basedir-option-improvements.dpatch (19998 bytes) added Basedir/node directory option improvements. addresses #188, #706, #715, #772, #890

basedir-option-improvements.dpatch

20 KiB

davidsarah commented

2010-07-22 01:59:04 +00:00

basedir-option-improvements.dpatch does the following:

add -d and --node-directory as a synonym for --basedir, in the commands that didn't already support it. This fixes #188 and #706 (but by making -d the global option).
tahoe create-key-generator now works consistently with the other commands that take basedir arguments (#772).
tahoe --help (and the subcommand help) now documents the -d option and gives the absolute path of the default basedir (#715).
on Windows, the default basedir is ~/.tahoe, like on other platforms, unless overridden by the registry (#890).

This patch depends on the one for #1108.

Known bugs:

tahoe create-key-generator --help documents a --multiple option that isn't actually valid.
the description of the --basedir option in the subcommand help should just say "Same as --node-directory .".
on Windows, backslashes in the default basedir path displayed in the help are doubled unnecessarily; see #1135.

[basedir-option-improvements.dpatch](/tahoe-lafs/trac-2024-07-25/attachments/000078ac-32e9-d389-ede4-10e162fe66ea) does the following: * add `-d` and `--node-directory` as a synonym for `--basedir`, in the commands that didn't already support it. This fixes #188 and #706 (but by making `-d` the global option). * `tahoe create-key-generator` now works consistently with the other commands that take basedir arguments (#772). * `tahoe --help` (and the subcommand help) now documents the `-d` option and gives the absolute path of the default basedir (#715). * on Windows, the default basedir is ~/.tahoe, like on other platforms, unless overridden by the registry (#890). This patch depends on the one for #1108. Known bugs: * `tahoe create-key-generator --help` documents a `--multiple` option that isn't actually valid. * the description of the `--basedir` option in the subcommand help should just say "Same as `--node-directory` .". * on Windows, backslashes in the default basedir path displayed in the help are doubled unnecessarily; see #1135.

zooko commented

2010-07-23 05:11:20 +00:00

Why does this ticket have the "test-needed" flag and also the "review-needed" flag?

zooko commented

2010-07-23 05:33:04 +00:00

Removing "review-needed" so that people who search for review-needed will find only tickets that are actionable for them. (This ticket is waiting for David-Sarah to explain what they mean by "test-needed".)

davidsarah commented

2010-08-02 00:33:21 +00:00

Don't use this patch; use the one attached to #188.

(What I meant by putting "test-needed" and "review-needed" in the flags is that it needs a design review, even though there are no tests yet. But Zooko and I agreed not to use "review-needed" for that.)

Don't use this patch; use the one attached to #188. (What I meant by putting "test-needed" and "review-needed" in the flags is that it needs a design review, even though there are no tests yet. But Zooko and I agreed not to use "review-needed" for that.)

david-sarah@jacaranda.org commented

2010-08-02 04:49:34 +00:00

In [4614/ticket798]:

Basedir/node directory option improvements for ticket798 branch. addresses #188, #706, #715, #772, #890

In [4614/ticket798]: ``` Basedir/node directory option improvements for ticket798 branch. addresses #188, #706, #715, #772, #890 ```

davidsarah commented

2010-08-08 00:52:35 +00:00

Applied to trunk in changeset:f952532f0822fbe7 changeset:54a9ba8232e2b8e9 changeset:a7c474a09893b9aa.

tahoe-lafs added the

fixed

label 2010-08-08 00:52:35 +00:00

tahoe-lafs closed this issue

2010-08-08 00:52:35 +00:00

davidsarah commented

2010-08-08 00:57:49 +00:00

NEWS changes were in changeset:0ae556c00ac79d4f changeset:2b15f35b867cebbd.

davidsarah commented

2010-08-08 01:44:14 +00:00

Replying to davidsarah:

Known bugs:

tahoe create-key-generator --help documents a --multiple option that isn't actually valid.

It is now valid.

the description of the --basedir option in the subcommand help should just say "Same as --node-directory .".

on Windows, backslashes in the default basedir path displayed in the help are doubled unnecessarily; see #1135.

These were also fixed. The help for tahoe start --help, for instance, includes something like:

  -C, --basedir=          Same as --node-directory.
  -d, --node-directory=   Specify which Tahoe node directory should be used.
                          [default for most commands:
                          'D:\cygwin\home\David\.tahoe']

and for tahoe run --help:

  -C, --basedir=          Same as --node-directory.
  -d, --node-directory=   Specify the directory of the node to be run. [default,
                          for 'tahoe run' only: current directory]

(It is ugly that the default for tahoe run is different, but I didn't want to break compatibility.)

Replying to [davidsarah](/tahoe-lafs/trac-2024-07-25/issues/715#issuecomment-71310): > Known bugs: > * `tahoe create-key-generator --help` documents a `--multiple` option that isn't actually valid. It is now valid. > * the description of the `--basedir` option in the subcommand help should just say "Same as `--node-directory` .". > * on Windows, backslashes in the default basedir path displayed in the help are doubled unnecessarily; see #1135. These were also fixed. The help for `tahoe start --help`, for instance, includes something like: ``` -C, --basedir= Same as --node-directory. -d, --node-directory= Specify which Tahoe node directory should be used. [default for most commands: 'D:\cygwin\home\David\.tahoe'] ``` and for `tahoe run --help`: ``` -C, --basedir= Same as --node-directory. -d, --node-directory= Specify the directory of the node to be run. [default, for 'tahoe run' only: current directory] ``` (It is ugly that the default for `tahoe run` is different, but I didn't want to break compatibility.)

Sign in to join this conversation.