help synopsis for 'tahoe ln' is confusing #1230

New Issue

tahoe-lafs · 2010-10-24T19:42:54Z

davidsarah commented

2010-10-24 19:42:54 +00:00

tahoe ln --help just says:

tahoe ln FROM TO

followed by the global options help.

It should be clearer about the order of arguments (which are the same as Unix ln(1), i.e. TARGET then LINK_NAME).

`tahoe ln --help` just says: ``` tahoe ln FROM TO ``` followed by the global options help. It should be clearer about the order of arguments (which are the same as Unix `ln(1)`, i.e. TARGET then LINK_NAME).

tahoe-lafs added the

labels 2010-10-24 19:42:54 +00:00

tahoe-lafs added this to the 1.9.0 milestone 2010-10-24 19:42:54 +00:00

tahoe-lafs modified the milestone from 1.9.0 to 1.8.2

2011-01-06 02:04:47 +00:00

davidsarah commented

2011-01-09 06:52:12 +00:00

Attachment tahoe-ln-help.darcs.patch (14831 bytes) added

CLI: improve synopsis and help description for 'tahoe ln' (now with test update and fix for typo). Also 'file' -> 'file or directory' in some of the 'tahoe --help' summaries. fixes #1230

**Attachment** tahoe-ln-help.darcs.patch (14831 bytes) added CLI: improve synopsis and help description for 'tahoe ln' (now with test update and fix for typo). Also 'file' -> 'file or directory' in some of the 'tahoe --help' summaries. fixes #1230

tahoe-ln-help.darcs.patch

14 KiB

davidsarah commented

2011-01-09 06:54:44 +00:00

$ bin/tahoe ln --help
tahoe ln FROM_LINK TO_LINK
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.
  -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. ['D:\cygwin\home\David\.tahoe']default:

  -u, --node-url=         Specify the URL of the Tahoe gateway node, such as
                          '<http://127.0.0.1:3456>'. This overrides the URL found
                          in the --node-directory .
      --dir-cap=          Specify which dirnode URI should be used as the
                          'tahoe' alias.
      --help              Display this help and exit.

Use 'tahoe ln' to duplicate a link (directory entry) already on the grid to
elsewhere on the grid. For example 'tahoe ln alias:some_file alias:new_file'.
causes 'alias:new_file' to point to the same object that 'alias:some_file'
points to.

(The argument order is the same as Unix ln. To remember the order, you can think
of this command as copying a link, rather than copying a file as 'tahoe cp'
does. Then the argument order is consistent with that of 'tahoe cp'.)

If linking a remote file into a remote directory, you'll need to append a '/' to
the name of the remote directory, e.g., 'tahoe ln tahoe:file1 tahoe:dir/', not
'tahoe ln tahoe:file1 tahoe:dir'.

Note that it is not possible to use this command to create links between local
and remote files.

``` $ bin/tahoe ln --help tahoe ln FROM_LINK TO_LINK 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. -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. ['D:\cygwin\home\David\.tahoe']default: -u, --node-url= Specify the URL of the Tahoe gateway node, such as '<http://127.0.0.1:3456>'. This overrides the URL found in the --node-directory . --dir-cap= Specify which dirnode URI should be used as the 'tahoe' alias. --help Display this help and exit. Use 'tahoe ln' to duplicate a link (directory entry) already on the grid to elsewhere on the grid. For example 'tahoe ln alias:some_file alias:new_file'. causes 'alias:new_file' to point to the same object that 'alias:some_file' points to. (The argument order is the same as Unix ln. To remember the order, you can think of this command as copying a link, rather than copying a file as 'tahoe cp' does. Then the argument order is consistent with that of 'tahoe cp'.) If linking a remote file into a remote directory, you'll need to append a '/' to the name of the remote directory, e.g., 'tahoe ln tahoe:file1 tahoe:dir/', not 'tahoe ln tahoe:file1 tahoe:dir'. Note that it is not possible to use this command to create links between local and remote files. ```

warner self-assigned this 2011-01-17 07:20:55 +00:00

warner commented

2011-01-17 08:27:26 +00:00

patch looks fine. I can't apply it, however, because it accidentally depends upon a bunch of other patches, including one named "Eliminate direct dependencies of Tahoe-LAFS on pywin32".

I'll apply a normal diff instead.

patch looks fine. I can't apply it, however, because it accidentally depends upon a bunch of other patches, including one named "`Eliminate direct dependencies of Tahoe-LAFS on pywin32`". I'll apply a normal diff instead.

Brian Warner <warner@lothar.com> commented

2011-01-17 08:45:34 +00:00

In changeset:b9fb74d2a09c43c7:

Improve 'tahoe ln' help text. Patch by David-Sarah. Closes #1230.

In changeset:b9fb74d2a09c43c7: ``` Improve 'tahoe ln' help text. Patch by David-Sarah. Closes #1230. ```

tahoe-lafs added the

fixed

label 2011-01-17 08:45:34 +00:00

tahoe-lafs closed this issue

2011-01-17 08:45:34 +00:00

warner commented

2011-01-17 08:46:41 +00:00

Done. I took the liberty of expanding upon the 'ln file dir/' section.

Brian Warner <warner@lothar.com> commented

2011-01-20 10:05:00 +00:00

In [4980/ticket1306]:

Improve 'tahoe ln' help text. Patch by David-Sarah. Closes #1230.

In [4980/ticket1306]: ``` Improve 'tahoe ln' help text. Patch by David-Sarah. Closes #1230. ```

Sign in to join this conversation.

No Label

LeastAuthority.com automation

code-frontend-ftp-sftp

code-frontend-magic-folder

somebody else's problem

No Milestone

No Assignees

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#1230