Ticket #1230: tahoe-ln-help.darcs.patch

File tahoe-ln-help.darcs.patch, 14.5 KB (added by davidsarah, at 2011-01-09T06:52:12Z)

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

Line 
11 patch for repository d:/tahoe/tahoe-clean:
2
3Sun Jan  9 06:20:38 GMT Standard Time 2011  david-sarah@jacaranda.org
4  * 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
5
6New patches:
7
8[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
9david-sarah@jacaranda.org**20110109062038
10 Ignore-this: 9042267eebecafde5f354168622cf865
11] {
12hunk ./src/allmydata/scripts/cli.py 272
13         self.to_file = argv_to_unicode(topath)
14 
15     def getSynopsis(self):
16-        return "%s ln FROM TO" % (os.path.basename(sys.argv[0]),)
17+        return "%s ln FROM_LINK TO_LINK" % (os.path.basename(sys.argv[0]),)
18+
19+    longdesc = """
20+    Use 'tahoe ln' to duplicate a link (directory entry) already on the grid
21+    to elsewhere on the grid. For example 'tahoe ln alias:some_file alias:new_file'.
22+    causes 'alias:new_file' to point to the same object that 'alias:some_file'
23+    points to.
24+
25+    (The argument order is the same as Unix ln. To remember the order, you
26+    can think of this command as copying a link, rather than copying a file
27+    as 'tahoe cp' does. Then the argument order is consistent with that of
28+    'tahoe cp'.)
29+
30+    If linking a remote file into a remote directory, you'll need to append a
31+    '/' to the name of the remote directory, e.g., 'tahoe ln tahoe:file1
32+    tahoe:dir/', not 'tahoe ln tahoe:file1 tahoe:dir'.
33+
34+    Note that it is not possible to use this command to create links between
35+    local and remote files.
36+    """
37 
38 class BackupConfigurationError(Exception):
39     pass
40hunk ./src/allmydata/scripts/cli.py 454
41     ["ls", None, ListOptions, "List a directory."],
42     ["get", None, GetOptions, "Retrieve a file from the grid."],
43     ["put", None, PutOptions, "Upload a file into the grid."],
44-    ["cp", None, CpOptions, "Copy one or more files."],
45+    ["cp", None, CpOptions, "Copy one or more files or directories."],
46     ["rm", None, RmOptions, "Unlink a file or directory on the grid."],
47     ["unlink", None, UnlinkOptions, "Unlink a file or directory on the grid (same as rm)."],
48     ["mv", None, MvOptions, "Move a file within the grid."],
49hunk ./src/allmydata/scripts/cli.py 458
50-    ["ln", None, LnOptions, "Make an additional link to an existing file."],
51+    ["ln", None, LnOptions, "Make an additional link to an existing file or directory."],
52     ["backup", None, BackupOptions, "Make target dir look like local dir."],
53     ["webopen", None, WebopenOptions, "Open a web browser to a grid file or directory."],
54     ["manifest", None, ManifestOptions, "List all files/directories in a subtree."],
55hunk ./src/allmydata/test/test_cli.py 472
56 
57     def test_ln(self):
58         help = str(cli.LnOptions())
59-        self.failUnless("ln FROM TO" in help, help)
60+        self.failUnless("ln FROM_LINK TO_LINK" in help, help)
61+        self.failUnless("Use 'tahoe ln' to duplicate a link" in help)
62 
63     def test_backup(self):
64         help = str(cli.BackupOptions())
65}
66
67Context:
68
69[Eliminate direct dependencies of Tahoe-LAFS on pywin32 (updated to trunk post-#1195). refs #1274
70david-sarah@jacaranda.org**20101231212745
71 Ignore-this: 1a64ebf2ddcd2e7d02a9a86ca2e3aaa9
72]
73[misc/build_helpers/show-tool-versions.py: remove attempts to show stdout.encoding and stderr.encoding that always printed None due to redirection. Also remove code to show os.path.supports_unicode_filenames which is not useful. refs #1251
74david-sarah@jacaranda.org**20110103015144
75 Ignore-this: 45e11431f7e2e0cebcb58e1841485cf8
76]
77[NEWS: 'top' for node processes, WUI formatting, removal of GUI apps, documentation updates, foolscap dependency. refs #174, #1219, #1225
78david-sarah@jacaranda.org**20110106005727
79 Ignore-this: f61ac58b4d10e635feb6f7391b1b48fe
80]
81[Makefile: update 'clean' target for files in bin/
82david-sarah@jacaranda.org**20110103052738
83 Ignore-this: 2bdbc4a50e13e508b66d0f65718c79b2
84]
85[test_runner: add test_import_in_repl, which uses 'bin/tahoe debug repl' to import the allmydata module and checks that it comes from the right path. Also, fix a latent bug that caused test_the_right_code to incorrectly conclude that a path mismatch was due to a Unicode path (causing a skip rather than a failure). This version of the patch avoids a confusing shadowing of 'srcfile'. refs #1258
86david-sarah@jacaranda.org**20110101192559
87 Ignore-this: 332920b103412b197b21e05989e3bda0
88]
89[docs: update performance.rst to describe the difference between already-uploaded and not-already-uploaded, to parameterize segment size, and to use "~A" to mean "approximately A"
90zooko@zooko.com**20110104065455
91 Ignore-this: 8df0d79a062ee19854c0211bd202f606
92]
93[allmydata/_auto_deps.py: add a comment reminding to change __init__.py when dependencies are added or removed. Clarify a comment in __init__.py. refs #1287
94david-sarah@jacaranda.org**20110101200502
95 Ignore-this: edb7059211da0c2ce511680d76731da5
96]
97[allmydata/__init__.py: don't use pkg_resources.require to get versions and paths. Also change pyOpenSSL to pyopenssl since that is the package name. fixes #1287
98david-sarah@jacaranda.org**20110101110141
99 Ignore-this: 48593ba449d7453005c9d2683fed6a69
100]
101[bin/tahoe-script.template: On non-Windows, invoke support/bin/tahoe directly as a script (rather than via python), so that 'top' for example will show it as 'tahoe'. On Windows, simplify some code that set argv[0], which is never used. fixes #174
102david-sarah@jacaranda.org**20101127232650
103 Ignore-this: 42a86f3eecfdc1ea7b76a7cc68626898
104]
105[test_runner: avoid unnecessary use of non-ASCII.
106david-sarah@jacaranda.org**20110101100101
107 Ignore-this: e2ff40dce6bb3b021306f2913d4e75df
108]
109[docs/quickstart.html: fix redundant, badly nested tag. refs #1284
110david-sarah@jacaranda.org**20110102175159
111 Ignore-this: 2ae9cc0b47d2e87b9eb64a0f517c4eef
112]
113[docs/quickstart.html: information about 'troublesome dependencies' and 'verified systems' de-emphasized by smaller italic font. Re-wrap so that the HTML source is readable (just about) as text. Minor wording tweaks. Improve organization by adding 'Windows Caveats' subsection. fixes #1284
114david-sarah@jacaranda.org**20110102174212
115 Ignore-this: e9dc57983974478200856651c5318fee
116]
117[NEWS: update entry for removal of Mac and Windows apps. refs #1282
118david-sarah@jacaranda.org**20101226042245
119 Ignore-this: c8099bc6e8235718d042c9a13c1e2425
120]
121[Move dependency imports from windows/depends.py (which has gone away) into src/allmydata/windows/tahoesvc.py. Also fix a pyflakes warning, and change the service display name from 'Allmydata Tahoe Node' to 'Tahoe-LAFS node'. refs #1282
122david-sarah@jacaranda.org**20101226042100
123 Ignore-this: ee45f324934e1251380206dbee6346d0
124]
125[Remove unmaintained Windows GUI app, except for windows/tahoesvc.py which is moved to src/allmydata/windows. refs #1282
126david-sarah@jacaranda.org**20101226040237
127 Ignore-this: cae37b6622a7dd5940acc7d3e6a98b90
128]
129[Remove the Makefile targets relating to the Mac GUI app. refs #1282
130david-sarah@jacaranda.org**20101226025859
131 Ignore-this: 75303be783974b41138744ec62b07965
132]
133[NEWS: remove unmaintained Mac GUI app. refs #1282
134david-sarah@jacaranda.org**20101226020858
135 Ignore-this: 40474a07f4a550b48563d35350be7ab5
136]
137[Remove unmaintained Mac GUI app. fixes #1282
138david-sarah@jacaranda.org**20101226020508
139 Ignore-this: b3613bf1abfd284d542bf7c753ec557a
140]
141[Remove src/allmydata/util/find_exe.py which is no longer used. fixes #1150
142david-sarah@jacaranda.org**20101226023206
143 Ignore-this: 7436c9b53bf210aed34a1a973cd9cace
144]
145[status_web_pages_review.darcs.patch
146freestorm77@gmail.com**20110102034214
147 Ignore-this: 29f1ecb36177f10f3f846b3d56b313b2
148 
149 I make some changes on status web pages
150 
151 status.xhtml:
152 - Delete unused webform_css link
153 - Align tables on the left
154 
155 tahoe-css:
156 - Do some minor changes on code synthax
157 - changes table.status-download-events style to look like other tables
158 
159 status.py:
160 - Align table on the left
161 - Changes table header
162 - Add heading tags
163 - Modify google api graph: add image border, calculate height to feet data
164 
165 signed-off-by: zooko@zooko.com
166 fixes #1219
167]
168[test_storage.py: fix a pyflakes unused import warning.
169david-sarah@jacaranda.org**20101231220756
170 Ignore-this: df08231540cb7dff9d2b038e47ab30ee
171]
172[test_storage.py: leave at least 512 MiB free when running test_large_share. refs #1195
173david-sarah@jacaranda.org**20101231203215
174 Ignore-this: b2144c0341c3452b5d4ba219e284ea0e
175]
176[storage: use fileutil's version of get_disk_stats() and get_available_space(), use mockery/fakery in tests, enable large share test on platforms with sparse files and if > 4 GiB of disk space is currently available
177zooko@zooko.com**20100910173629
178 Ignore-this: 1304f1164c661de6d5304f993eb9b27b
179]
180[fileutil: copy in the get_disk_stats() and get_available_space() functions from storage/server.py
181zooko@zooko.com**20100910173520
182 Ignore-this: 8b15569715f710f4fc5092f7ca109253
183]
184[Update foolscap version requirement to 0.6.0, to address http://foolscap.lothar.com/trac/ticket/167
185david-sarah@jacaranda.org**20101231060039
186 Ignore-this: 98d2b8086a1a500b9f4565bca5a3810
187]
188[docs/webapi.rst: typos.
189david-sarah@jacaranda.org**20101230034422
190 Ignore-this: d1f5166d72cc711f7e0d9981eac9105e
191]
192[docs/webapi.rst: capitalization, formatting of section on URL character encoding, and a correction about Internet Explorer.
193david-sarah@jacaranda.org**20101230034049
194 Ignore-this: b3b9819d2fb264b4cdc5c8afd4e8c48d
195]
196[docs: corrections and clarifications.
197david-sarah@jacaranda.org**20101227051056
198 Ignore-this: e33202858c7644c58f3f924b164294b6
199]
200[docs: more formatting cleanups and corrections. Spell webapi and wapi as web-API.
201david-sarah@jacaranda.org**20101227050533
202 Ignore-this: 18b23cbfb780df585d8a722a1ec63e94
203]
204[docs/debian.rst: bring description of building dependencies from source up-to-date, and change hostname from allmydata.com to tahoe-lafs.org.
205david-sarah@jacaranda.org**20101212222912
206 Ignore-this: f38462afc88b4475195610385a28391c
207]
208[docs/architecture.rst: correct rst syntax.
209david-sarah@jacaranda.org**20101212202003
210 Ignore-this: 3fbe12feb28bec6f1c63aedbc79aad21
211]
212[docs/architecture.rst: formatting.
213david-sarah@jacaranda.org**20101212201719
214 Ignore-this: 305fa5dfc2939355eaf6d0d2161eb1ff
215]
216[docs: linkification, wording improvements.
217david-sarah@jacaranda.org**20101212201234
218 Ignore-this: 4e67287f527a8bc728cfbd93255d2aae
219]
220[docs: formatting.
221david-sarah@jacaranda.org**20101212201115
222 Ignore-this: 2e0ed394ac7726651d3a4f2c4b0d3798
223]
224[docs/configuration.rst: more formatting tweaks; which -> that.
225david-sarah@jacaranda.org**20101212195522
226 Ignore-this: a7becb7021854ca5a90edd892b36fdd7
227]
228[docs/configuration.rst: more changes to formatting.
229david-sarah@jacaranda.org**20101212194511
230 Ignore-this: 491aac33e5f5268d224359f1447d10be
231]
232[docs/configuration.rst: changes to formatting (mainly putting commands and filenames in monospace).
233david-sarah@jacaranda.org**20101212181828
234 Ignore-this: 8a1480e2d5f43bee678476424615b50f
235]
236[scripts/backupdb.py: more accurate comment about path field.
237david-sarah@jacaranda.org**20101212170320
238 Ignore-this: 50e47a2228a85207bbcd188a78a0d4e6
239]
240[scripts/cli.py: fix missing 'put' in usage example for 'tahoe put'.
241david-sarah@jacaranda.org**20101212170207
242 Ignore-this: 2cbadf066fff611fc03d3c0ff97ce6ec
243]
244[docs/frontends/CLI.rst: changes to formatting (mainly putting commands and filenames in monospace), and to command syntax to reflect that DIRCAP/... is accepted. Clarify the syntax of 'tahoe put' and other minor corrections. Tahoe -> Tahoe-LAFS.
245david-sarah@jacaranda.org**20101212165800
246 Ignore-this: a123ef6b564aa8624d1e79c97068ea12
247]
248[docs/frontends/CLI.rst: Unicode arguments to 'tahoe' work on Windows as of v1.7.1.
249david-sarah@jacaranda.org**20101212063740
250 Ignore-this: 3977a99dfa86ac33a44171deaf43aaab
251]
252[docs/known_issues.rst: fix title and linkify another URL. refs #1225
253david-sarah@jacaranda.org**20101212062817
254 Ignore-this: cc91287f7fb51c23440b3d2fe79c449c
255]
256[docs/known_issues.rst: fix an external link. refs #1225
257david-sarah@jacaranda.org**20101212062435
258 Ignore-this: b8cbf12f353131756c358965c48060ec
259]
260[Fix a link from uri.rst to dirnodes.rst. refs #1225
261david-sarah@jacaranda.org**20101212054502
262 Ignore-this: af6205299f5c9a33229cab259c00f9d5
263]
264[Fix a link from webapi.rst to FTP-and-SFTP.rst. refs #1225
265david-sarah@jacaranda.org**20101212053435
266 Ignore-this: 2b9f88678c3447ea860d6b61e8799858
267]
268[More specific hyperlink to architecture.rst from helper.rst. refs #1225
269david-sarah@jacaranda.org**20101212052607
270 Ignore-this: 50424c768fca481252fabf58424852dc
271]
272[Update hyperlinks between docs, and linkify some external references. refs #1225
273david-sarah@jacaranda.org**20101212051459
274 Ignore-this: cd43a4c3d3de1f832abfa88d5fc4ace1
275]
276[docs/specifications/dirnodes.rst: fix references to mutable.rst. refs #1225
277david-sarah@jacaranda.org**20101212012720
278 Ignore-this: 6819b4b4e06e947ee48b365e840db37d
279]
280[docs/specifications/mutable.rst: correct the magic string for v1 mutable containers. refs #1225
281david-sarah@jacaranda.org**20101212011400
282 Ignore-this: 99a5fcdd40cef83dbb08f323f6cdaaca
283]
284[Move .txt files in docs/frontends and docs/specifications to .rst. refs #1225
285david-sarah@jacaranda.org**20101212010251
286 Ignore-this: 8796d35d928370f7dc6ad2dafdc1c0fe
287]
288[Convert docs/frontends and docs/specifications to reStructuredText format (not including file moves).
289david-sarah@jacaranda.org**20101212004632
290 Ignore-this: e3ceb2d832d73875abe48624ddbb5622
291]
292[scripts/cli.py: remove the disclaimer in the help for 'tahoe cp' that it does not handle non-ASCII filenames well. (At least, we intend to handle them.)
293david-sarah@jacaranda.org**20101130002145
294 Ignore-this: 94c003efaa20b9eb4a83503d79844ca
295]
296[relnotes.txt: fifth -> sixth labor-of-love release
297zooko@zooko.com**20101129045647
298 Ignore-this: 21c245015268b38916e3a138d256c09d
299]
300[Makefile: BB_BRANCH is set to the empty string for trunk, not the string 'trunk'.
301david-sarah@jacaranda.org**20101128233512
302 Ignore-this: 5a7ef8eb10475636d21b91e25b56c369
303]
304[relnotes.txt: eleventh -> twelfth release.
305david-sarah@jacaranda.org**20101128223321
306 Ignore-this: 1e26410156a665271c1170803dea2c0d
307]
308[relnotes.tst: point to known_issues.rst, not known_issues.txt.
309david-sarah@jacaranda.org**20101128222918
310 Ignore-this: 60194eb4544cac446fe4f60b3e34b887
311]
312[quickstart.html: fix link to point to allmydata-tahoe-1.8.1.zip.
313david-sarah@jacaranda.org**20101128221728
314 Ignore-this: 7b3ee86f8256aa12f5d862f689f3ee29
315]
316[TAG allmydata-tahoe-1.8.1
317david-sarah@jacaranda.org**20101128212336
318 Ignore-this: 9c18bdeaef4822f590d2a0d879e00621
319]
320Patch bundle hash:
32118d62364ed715fc5822a8d12971a858116e33b63