ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2024-12-20 05:28:04 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Brian Warner 2011-01-17 00:14:21 -08:00
parent 09a2241471
commit b9fb74d2a0
2 changed files with 27 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/allmydata/scripts/cli.py
View File

@ -269,7 +269,29 @@ class LnOptions(VDriveOptions):
self.to_file = argv_to_unicode(topath)
def getSynopsis(self):
return "%s ln FROM TO" % (os.path.basename(sys.argv[0]),)
return "%s ln FROM_LINK TO_LINK" % (os.path.basename(sys.argv[0]),)
longdesc = """
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'.)
When 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/' (which is shorthand for 'tahoe ln tahoe:file1
tahoe:dir/file1'). If you forget the '/', e.g. 'tahoe ln tahoe:file1
tahoe:dir', the 'ln' command will refuse to overwrite the 'tahoe:dir'
directory, and will exit with an error.
Note that it is not possible to use this command to create links between
local and remote files.
"""
class BackupConfigurationError(Exception):
pass
@ -432,11 +454,11 @@ subCommands = [
["ls", None, ListOptions, "List a directory."],
["get", None, GetOptions, "Retrieve a file from the grid."],
["put", None, PutOptions, "Upload a file into the grid."],
["cp", None, CpOptions, "Copy one or more files."],
["cp", None, CpOptions, "Copy one or more files or directories."],
["rm", None, RmOptions, "Unlink a file or directory on the grid."],
["unlink", None, UnlinkOptions, "Unlink a file or directory on the grid (same as rm)."],
["mv", None, MvOptions, "Move a file within the grid."],
["ln", None, LnOptions, "Make an additional link to an existing file."],
["ln", None, LnOptions, "Make an additional link to an existing file or directory."],
["backup", None, BackupOptions, "Make target dir look like local dir."],
["webopen", None, WebopenOptions, "Open a web browser to a grid file or directory."],
["manifest", None, ManifestOptions, "List all files/directories in a subtree."],

3
src/allmydata/test/test_cli.py
View File

@ -469,7 +469,8 @@ class Help(unittest.TestCase):
def test_ln(self):
help = str(cli.LnOptions())
self.failUnless("ln FROM TO" in help, help)
self.failUnless("ln FROM_LINK TO_LINK" in help, help)
self.failUnless("Use 'tahoe ln' to duplicate a link" in help)
def test_backup(self):
help = str(cli.BackupOptions())