Ticket #1429: drop-upload-docs.darcs.patch

File drop-upload-docs.darcs.patch, 34.8 KB (added by davidsarah, at 2011-08-08T19:29:14Z)

Documentation for drop-upload frontend. refs #1429

Line 
11 patch for repository http://tahoe-lafs.org/source/tahoe-lafs/trunk:
2
3Mon Aug  8 19:21:46 BST 2011  david-sarah@jacaranda.org
4  * Documentation for drop-upload frontend. refs #1429
5
6New patches:
7
8[Documentation for drop-upload frontend. refs #1429
9david-sarah@jacaranda.org**20110808182146
10 Ignore-this: b33110834e586c0b784d1736c2af5779
11] {
12hunk ./docs/configuration.rst 362
13     for instructions on configuring these services, and the ``[ftpd]`` and
14     ``[sftpd]`` sections of ``tahoe.cfg``.
15 
16+Drop-Upload
17+
18+    As of Tahoe-LAFS v1.9.0, a node running on Linux can be configured to
19+    automatically upload files that are created or changed in a specified
20+    local directory. See `<frontends/drop_upload.rst>`_ for details.
21+
22 
23 
24 Storage Server Configuration
25addfile ./docs/frontends/drop-upload.rst
26hunk ./docs/frontends/drop-upload.rst 1
27+===============================
28+Tahoe-LAFS Drop-Upload Frontend
29+===============================
30+
31+1.  `Introduction`_
32+2.  `Configuration`_
33+3.  `Known Issues and Limitations`_
34+
35+
36+Introduction
37+============
38+
39+The drop-upload frontend allows an upload to a Tahoe-LAFS grid to be triggered
40+automatically whenever a file is created or changed in a specific local
41+directory. This is a preview of a feature that we expect to support across
42+several platforms, but it currently works only on Linux.
43+
44+The implementation was written as a prototype at the First International
45+Tahoe-LAFS Summit in June 2011, and is not currently in as mature a state as
46+the other frontends (web, CLI, FTP and SFTP). This means that you probably
47+should not keep important data in the upload directory, and should not rely
48+on all changes to files in the local directory to result in successful uploads.
49+There might be incompatible changes to how the feature is configured in
50+future versions. There is even the possibility that it may be abandoned, for
51+example if unsolveable reliability issues are found.
52+
53+We are very interested in feedback on how well this feature works for you, and
54+suggestions to improve its usability, functionality, and reliability.
55+
56+
57+Configuration
58+=============
59+
60+The drop-upload frontend runs as part of a gateway node. To set it up, you
61+need to choose the local directory to monitor for file changes, and a mutable
62+directory on the grid to which files will be uploaded.
63+
64+These settings are configured in the ``[drop_upload]`` section of the
65+gateway's ``tahoe.cfg`` file.
66+
67+``[drop_upload]``
68+
69+``enabled = (boolean, optional)``
70+
71+    If this is ``True``, drop-upload will be enabled (provided that the
72+    ``upload.uri`` and ``local.directory`` fields are also set). The default
73+    value is ``False``.
74+
75+``upload.uri = (URI)``
76+
77+    This is the Tahoe URI of an existing mutable directory to be used as
78+    the target of uploads. It must be the full URI of the directory
79+    (starting with ``URI:DIR2:``), and cannot include an alias or path.
80+
81+``local.directory = (UTF-8 path)``
82+
83+    This specifies the local directory to be monitored for new or changed
84+    files. If the path contains non-ASCII characters, it should be encoded
85+    in UTF-8 regardless of the system's filesystem encoding. Relative paths
86+    will be interpreted starting from the node's base directory.
87+
88+After setting the above fields and starting or restarting the gateway,
89+you can confirm that the feature is working by copying a file into the
90+local directory. Then, use the WUI or CLI to check that it has appeared
91+in the upload directory with the same filename. A large file may take some
92+time to appear, since it is only linked into the directory after the upload
93+has completed.
94+
95+The 'Operational Statistics' page linked from the Welcome page shows
96+counts of the number of files uploaded, the number of change events currently
97+queued, and the number of failed uploads. The 'Recent Uploads and Downloads'
98+page and the node log_ may be helpful to determine the cause of any failures.
99+
100+.. _log: ../logging.rst
101+
102+
103+Known Issues and Limitations
104+============================
105+
106+This frontend only works on Linux. There is an even-more-experimental
107+implementation for Windows (`#1431`_), and a ticket to add support for
108+Mac OS X and BSD-based systems (`#1432`_).
109+
110+Subdirectories of the local directory are not monitored. If a subdirectory
111+is created, it will be ignored. (`#1433`_)
112+
113+If files are created or changed in the local directory just after the gateway
114+has started, it might not have connected to a sufficient number of servers
115+when the upload is attempted, causing the upload to fail. (`#1449`_)
116+
117+Files that were created or changed in the local directory while the gateway
118+was not running, will not be uploaded. (`#1458`_)
119+
120+The only way to determine whether uploads have failed is to look at the
121+'Operational Statistics' page linked from the Welcome page. This only shows
122+a count of failures, not the names of files. Uploads are never retried.
123+
124+The drop-upload frontend performs its uploads sequentially (i.e. it waits
125+until each upload is finished before starting the next), even when there
126+would be enough memory and bandwidth to efficiently perform them in parallel.
127+A drop-upload can occur in parallel with an upload by a different frontend,
128+though. (`#1459`_)
129+
130+If there are a large number of near-simultaneous file creation or
131+change events (greater than the number specified in the file
132+``/proc/sys/fs/inotify/max_queued_events``), it is possible that some events
133+could be missed. This is fairly unlikely under normal circumstances, because
134+the default value of ``max_queued_events`` in most Linux distributions is
135+16384, and events are removed from this queue immediately without waiting for
136+the corresponding upload to complete. (`#1430`_)
137+
138+Some filesystems may not support the necessary change notifications.
139+So, it is recommended for the local directory to be on a directly attached
140+disk-based filesystem, not a network filesystem or one provided by a virtual
141+machine.
142+
143+Attempts to read the mutable directory at about the same time as an uploaded
144+file is being linked into it, might fail, even if they are done through the
145+same gateway. (`#1105`_)
146+
147+Files are always uploaded as immutable. If there is an existing mutable file
148+of the same name in the upload directory, it will be unlinked and replaced
149+with an immutable file.
150+
151+If a file in the upload directory is changed (actually relinked to a new
152+file), then the old file is still present on the grid, and any other caps
153+to it will remain valid. See `docs/garbage-collection.rst
154+<../garbage-collection.rst>`_ for how to reclaim the space used by files
155+that are no longer needed.
156+
157+Unicode names are supported, but the local name of a file must be encoded
158+correctly in order for it to be uploaded. The expected encoding is that
159+printed by ``python -c "import sys; print sys.getfilesystemencoding()"``.
160+
161+.. _`#1105`: http://tahoe-lafs.org/trac/tahoe-lafs/ticket/1105
162+.. _`#1430`: http://tahoe-lafs.org/trac/tahoe-lafs/ticket/1430
163+.. _`#1431`: http://tahoe-lafs.org/trac/tahoe-lafs/ticket/1431
164+.. _`#1432`: http://tahoe-lafs.org/trac/tahoe-lafs/ticket/1432
165+.. _`#1449`: http://tahoe-lafs.org/trac/tahoe-lafs/ticket/1449
166+.. _`#1458`: http://tahoe-lafs.org/trac/tahoe-lafs/ticket/1458
167+.. _`#1459`: http://tahoe-lafs.org/trac/tahoe-lafs/ticket/1459
168}
169
170Context:
171
172[node.py: ensure that client and introducer nodes record their port number and use that port on the next restart, fixing a regression caused by #1385. fixes #1469.
173david-sarah@jacaranda.org**20110806221934
174 Ignore-this: 1aa9d340b6570320ab2f9edc89c9e0a8
175]
176[test_runner.py: fix a race condition in the test when NODE_URL_FILE is written before PORTNUM_FILE. refs #1469
177david-sarah@jacaranda.org**20110806231842
178 Ignore-this: ab01ae7cec3a073e29eec473e64052a0
179]
180[test_runner.py: cleanups of HOTLINE_FILE writing and removal.
181david-sarah@jacaranda.org**20110806231652
182 Ignore-this: 25f5c5d6f5d8faebb26a4ce80110a335
183]
184[test_runner.py: remove an unused constant.
185david-sarah@jacaranda.org**20110806221416
186 Ignore-this: eade2695cbabbea9cafeaa8debe410bb
187]
188[node.py: fix the error path for a missing config option so that it works for a Unicode base directory.
189david-sarah@jacaranda.org**20110806221007
190 Ignore-this: 4eb9cc04b2ce05182a274a0d69dafaf3
191]
192[test_runner.py: test that client and introducer nodes record their port number and use that port on the next restart. This tests for a regression caused by ref #1385.
193david-sarah@jacaranda.org**20110806220635
194 Ignore-this: 40a0c040b142dbddd47e69b3c3712f5
195]
196[test_runner.py: fix a bug in CreateNode.do_create introduced in changeset [5114] when the tahoe.cfg file has been written with CRLF line endings. refs #1385
197david-sarah@jacaranda.org**20110804003032
198 Ignore-this: 7b7afdcf99da6671afac2d42828883eb
199]
200[test_client.py: repair Basic.test_error_on_old_config_files. refs #1385
201david-sarah@jacaranda.org**20110803235036
202 Ignore-this: 31e2a9c3febe55948de7e144353663e
203]
204[test_checker.py: increase timeout for TooParallel.test_immutable again. The ARM buildslave took 38 seconds, so 40 seconds is too close to the edge; make it 80.
205david-sarah@jacaranda.org**20110803214042
206 Ignore-this: 2d8026a6b25534e01738f78d6c7495cb
207]
208[test_runner.py: fix RunNode.test_introducer to not rely on the mtime of introducer.furl to detect when the node has restarted. Instead we detect when node.url has been written. refs #1385
209david-sarah@jacaranda.org**20110803180917
210 Ignore-this: 11ddc43b107beca42cb78af88c5c394c
211]
212[Further improve error message about old config files. refs #1385
213david-sarah@jacaranda.org**20110803174546
214 Ignore-this: 9d6cc3c288d9863dce58faafb3855917
215]
216[Slightly improve error message about old config files (avoid unnecessary Unicode escaping). refs #1385
217david-sarah@jacaranda.org**20110803163848
218 Ignore-this: a3e3930fba7ccf90b8db3d2ed5829df4
219]
220[test_checker.py: increase timeout for TooParallel.test_immutable (was consistently failing on ARM buildslave).
221david-sarah@jacaranda.org**20110803163213
222 Ignore-this: d0efceaf12628e8791862b80c85b5d56
223]
224[Fix the bug that prevents an introducer from starting when introducer.furl already exists. Also remove some dead code that used to read old config files, and rename 'warn_about_old_config_files' to reflect that it's not a warning. refs #1385
225david-sarah@jacaranda.org**20110803013212
226 Ignore-this: 2d6cd14bd06a7493b26f2027aff78f4d
227]
228[test_runner.py: modify RunNode.test_introducer to test that starting an introducer works when the introducer.furl file already exists. refs #1385
229david-sarah@jacaranda.org**20110803012704
230 Ignore-this: 8cf7f27ac4bfbb5ad8ca4a974106d437
231]
232[verifier: correct a bug introduced in changeset [5106] that caused us to only verify the first block of a file. refs #1395
233david-sarah@jacaranda.org**20110802172437
234 Ignore-this: 87fb77854a839ff217dce73544775b11
235]
236[test_repairer: add a deterministic test of share data corruption that always flips the bits of the last byte of the share data. refs #1395
237david-sarah@jacaranda.org**20110802175841
238 Ignore-this: 72f54603785007e88220c8d979e08be7
239]
240[verifier: serialize the fetching of blocks within a share so that we don't use too much RAM
241zooko@zooko.com**20110802063703
242 Ignore-this: debd9bac07dcbb6803f835a9e2eabaa1
243 
244 Shares are still verified in parallel, but within a share, don't request a
245 block until the previous block has been verified and the memory we used to hold
246 it has been freed up.
247 
248 Patch originally due to Brian. This version has a mockery-patchery-style test
249 which is "low tech" (it implements the patching inline in the test code instead
250 of using an extension of the mock.patch() function from the mock library) and
251 which unpatches in case of exception.
252 
253 fixes #1395
254]
255[add docs about timing-channel attacks
256Brian Warner <warner@lothar.com>**20110802044541
257 Ignore-this: 73114d5f5ed9ce252597b707dba3a194
258]
259['test-coverage' now needs PYTHONPATH=. to find TOP/twisted/plugins/
260Brian Warner <warner@lothar.com>**20110802041952
261 Ignore-this: d40f1f4cb426ea1c362fc961baedde2
262]
263[remove nodeid from WriteBucketProxy classes and customers
264warner@lothar.com**20110801224317
265 Ignore-this: e55334bb0095de11711eeb3af827e8e8
266 refs #1363
267]
268[remove get_serverid() from ReadBucketProxy and customers, including Checker
269warner@lothar.com**20110801224307
270 Ignore-this: 837aba457bc853e4fd413ab1a94519cb
271 and debug.py dump-share commands
272 refs #1363
273]
274[reject old-style (pre-Tahoe-LAFS-v1.3) configuration files
275zooko@zooko.com**20110801232423
276 Ignore-this: b58218fcc064cc75ad8f05ed0c38902b
277 Check for the existence of any of them and if any are found raise exception which will abort the startup of the node.
278 This is a backwards-incompatible change for anyone who is still using old-style configuration files.
279 fixes #1385
280]
281[whitespace-cleanup
282zooko@zooko.com**20110725015546
283 Ignore-this: 442970d0545183b97adc7bd66657876c
284]
285[tests: use fileutil.write() instead of open() to ensure timely close even without CPython-style reference counting
286zooko@zooko.com**20110331145427
287 Ignore-this: 75aae4ab8e5fa0ad698f998aaa1888ce
288 Some of these already had an explicit close() but I went ahead and replaced them with fileutil.write() as well for the sake of uniformity.
289]
290[Address Kevan's comment in #776 about Options classes missed when adding 'self.command_name'. refs #776, #1359
291david-sarah@jacaranda.org**20110801221317
292 Ignore-this: 8881d42cf7e6a1d15468291b0cb8fab9
293]
294[docs/frontends/webapi.rst: change some more instances of 'delete' or 'remove' to 'unlink', change some section titles, and use two blank lines between all sections. refs #776, #1104
295david-sarah@jacaranda.org**20110801220919
296 Ignore-this: 572327591137bb05c24c44812d4b163f
297]
298[cleanup: implement rm as a synonym for unlink rather than vice-versa. refs #776
299david-sarah@jacaranda.org**20110801220108
300 Ignore-this: 598dcbed870f4f6bb9df62de9111b343
301]
302[docs/webapi.rst: address Kevan's comments about use of 'delete' on ref #1104
303david-sarah@jacaranda.org**20110801205356
304 Ignore-this: 4fbf03864934753c951ddeff64392491
305]
306[docs: some changes of 'delete' or 'rm' to 'unlink'. refs #1104
307david-sarah@jacaranda.org**20110713002722
308 Ignore-this: 304d2a330d5e6e77d5f1feed7814b21c
309]
310[WUI: change the label of the button to unlink a file from 'del' to 'unlink'. Also change some internal names to 'unlink', and allow 't=unlink' as a synonym for 't=delete' in the web-API interface. Incidentally, improve a test to check for the rename button as well as the unlink button. fixes #1104
311david-sarah@jacaranda.org**20110713001218
312 Ignore-this: 3eef6b3f81b94a9c0020a38eb20aa069
313]
314[src/allmydata/web/filenode.py: delete a stale comment that was made incorrect by changeset [3133].
315david-sarah@jacaranda.org**20110801203009
316 Ignore-this: b3912e95a874647027efdc97822dd10e
317]
318[fix typo introduced during rebasing of 'remove get_serverid from
319Brian Warner <warner@lothar.com>**20110801200341
320 Ignore-this: 4235b0f585c0533892193941dbbd89a8
321 DownloadStatus.add_dyhb_request and customers' patch, to fix test failure.
322]
323[remove get_serverid from DownloadStatus.add_dyhb_request and customers
324zooko@zooko.com**20110801185401
325 Ignore-this: db188c18566d2d0ab39a80c9dc8f6be6
326 This patch is a rebase of a patch originally written by Brian. I didn't change any of the intent of Brian's patch, just ported it to current trunk.
327 refs #1363
328]
329[remove get_serverid from DownloadStatus.add_block_request and customers
330zooko@zooko.com**20110801185344
331 Ignore-this: 8bfa8201d6147f69b0fbe31beea9c1e
332 This is a rebase of a patch Brian originally wrote. I haven't changed the intent of that patch, just ported it to trunk.
333 refs #1363
334]
335[apply zooko's advice: storage_client get_known_servers() returns a frozenset, caller sorts
336warner@lothar.com**20110801174452
337 Ignore-this: 2aa13ea6cbed4e9084bd604bf8633692
338 refs #1363
339]
340[test_immutable.Test: rewrite to use NoNetworkGrid, now takes 2.7s not 97s
341warner@lothar.com**20110801174444
342 Ignore-this: 54f30b5d7461d2b3514e2a0172f3a98c
343 remove now-unused ShareManglingMixin
344 refs #1363
345]
346[DownloadStatus.add_known_share wants to be used by Finder, web.status
347warner@lothar.com**20110801174436
348 Ignore-this: 1433bcd73099a579abe449f697f35f9
349 refs #1363
350]
351[replace IServer.name() with get_name(), and get_longname()
352warner@lothar.com**20110801174428
353 Ignore-this: e5a6f7f6687fd7732ddf41cfdd7c491b
354 
355 This patch was originally written by Brian, but was re-recorded by Zooko to use
356 darcs replace instead of hunks for any file in which it would result in fewer
357 total hunks.
358 refs #1363
359]
360[upload.py: apply David-Sarah's advice rename (un)contacted(2) trackers to first_pass/second_pass/next_pass
361zooko@zooko.com**20110801174143
362 Ignore-this: e36e1420bba0620a0107bd90032a5198
363 This patch was written by Brian but was re-recorded by Zooko (with David-Sarah looking on) to use darcs replace instead of editing to rename the three variables to their new names.
364 refs #1363
365]
366[Coalesce multiple Share.loop() calls, make downloads faster. Closes #1268.
367Brian Warner <warner@lothar.com>**20110801151834
368 Ignore-this: 48530fce36c01c0ff708f61c2de7e67a
369]
370[src/allmydata/_auto_deps.py: 'i686' is another way of spelling x86.
371david-sarah@jacaranda.org**20110801034035
372 Ignore-this: 6971e0621db2fba794d86395b4d51038
373]
374[tahoe_rm.py: better error message when there is no path. refs #1292
375david-sarah@jacaranda.org**20110122064212
376 Ignore-this: ff3bb2c9f376250e5fd77eb009e09018
377]
378[test_cli.py: Test for error message when 'tahoe rm' is invoked without a path. refs #1292
379david-sarah@jacaranda.org**20110104105108
380 Ignore-this: 29ec2f2e0251e446db96db002ad5dd7d
381]
382[src/allmydata/__init__.py: suppress a spurious warning from 'bin/tahoe --version[-and-path]' about twisted-web and twisted-core packages.
383david-sarah@jacaranda.org**20110801005209
384 Ignore-this: 50e7cd53cca57b1870d9df0361c7c709
385]
386[test_cli.py: use to_str on fields loaded using simplejson.loads in new tests. refs #1304
387david-sarah@jacaranda.org**20110730032521
388 Ignore-this: d1d6dfaefd1b4e733181bf127c79c00b
389]
390[cli: make 'tahoe cp' overwrite mutable files in-place
391Kevan Carstensen <kevan@isnotajoke.com>**20110729202039
392 Ignore-this: b2ad21a19439722f05c49bfd35b01855
393]
394[SFTP: write an error message to standard error for unrecognized shell commands. Change the existing message for shell sessions to be written to standard error, and refactor some duplicated code. Also change the lines of the error messages to end in CRLF, and take into account Kevan's review comments. fixes #1442, #1446
395david-sarah@jacaranda.org**20110729233102
396 Ignore-this: d2f2bb4664f25007d1602bf7333e2cdd
397]
398[src/allmydata/scripts/cli.py: fix pyflakes warning.
399david-sarah@jacaranda.org**20110728021402
400 Ignore-this: 94050140ddb99865295973f49927c509
401]
402[Fix the help synopses of CLI commands to include [options] in the right place. fixes #1359, fixes #636
403david-sarah@jacaranda.org**20110724225440
404 Ignore-this: 2a8e488a5f63dabfa9db9efd83768a5
405]
406[encodingutil: argv and output encodings are always the same on all platforms. Lose the unnecessary generality of them being different. fixes #1120
407david-sarah@jacaranda.org**20110629185356
408 Ignore-this: 5ebacbe6903dfa83ffd3ff8436a97787
409]
410[docs/man/tahoe.1: add man page. fixes #1420
411david-sarah@jacaranda.org**20110724171728
412 Ignore-this: fc7601ec7f25494288d6141d0ae0004c
413]
414[Update the dependency on zope.interface to fix an incompatiblity between Nevow and zope.interface 3.6.4. fixes #1435
415david-sarah@jacaranda.org**20110721234941
416 Ignore-this: 2ff3fcfc030fca1a4d4c7f1fed0f2aa9
417]
418[frontends/ftpd.py: remove the check for IWriteFile.close since we're now guaranteed to be using Twisted >= 10.1 which has it.
419david-sarah@jacaranda.org**20110722000320
420 Ignore-this: 55cd558b791526113db3f83c00ec328a
421]
422[Update the dependency on Twisted to >= 10.1. This allows us to simplify some documentation: it's no longer necessary to install pywin32 on Windows, or apply a patch to Twisted in order to use the FTP frontend. fixes #1274, #1438. refs #1429
423david-sarah@jacaranda.org**20110721233658
424 Ignore-this: 81b41745477163c9b39c0b59db91cc62
425]
426[misc/build_helpers/run_trial.py: undo change to block pywin32 (it didn't work because run_trial.py is no longer used). refs #1334
427david-sarah@jacaranda.org**20110722035402
428 Ignore-this: 5d03f544c4154f088e26c7107494bf39
429]
430[misc/build_helpers/run_trial.py: ensure that pywin32 is not on the sys.path when running the test suite. Includes some temporary debugging printouts that will be removed. refs #1334
431david-sarah@jacaranda.org**20110722024907
432 Ignore-this: 5141a9f83a4085ed4ca21f0bbb20bb9c
433]
434[docs/running.rst: use 'tahoe run ~/.tahoe' instead of 'tahoe run' (the default is the current directory, unlike 'tahoe start').
435david-sarah@jacaranda.org**20110718005949
436 Ignore-this: 81837fbce073e93d88a3e7ae3122458c
437]
438[docs/running.rst: say to put the introducer.furl in tahoe.cfg.
439david-sarah@jacaranda.org**20110717194315
440 Ignore-this: 954cc4c08e413e8c62685d58ff3e11f3
441]
442[README.txt: say that quickstart.rst is in the docs directory.
443david-sarah@jacaranda.org**20110717192400
444 Ignore-this: bc6d35a85c496b77dbef7570677ea42a
445]
446[setup: remove the dependency on foolscap's "secure_connections" extra, add a dependency on pyOpenSSL
447zooko@zooko.com**20110717114226
448 Ignore-this: df222120d41447ce4102616921626c82
449 fixes #1383
450]
451[test_sftp.py cleanup: remove a redundant definition of failUnlessReallyEqual.
452david-sarah@jacaranda.org**20110716181813
453 Ignore-this: 50113380b368c573f07ac6fe2eb1e97f
454]
455[docs: add missing link in NEWS.rst
456zooko@zooko.com**20110712153307
457 Ignore-this: be7b7eb81c03700b739daa1027d72b35
458]
459[contrib: remove the contributed fuse modules and the entire contrib/ directory, which is now empty
460zooko@zooko.com**20110712153229
461 Ignore-this: 723c4f9e2211027c79d711715d972c5
462 Also remove a couple of vestigial references to figleaf, which is long gone.
463 fixes #1409 (remove contrib/fuse)
464]
465[add Protovis.js-based download-status timeline visualization
466Brian Warner <warner@lothar.com>**20110629222606
467 Ignore-this: 477ccef5c51b30e246f5b6e04ab4a127
468 
469 provide status overlap info on the webapi t=json output, add decode/decrypt
470 rate tooltips, add zoomin/zoomout buttons
471]
472[add more download-status data, fix tests
473Brian Warner <warner@lothar.com>**20110629222555
474 Ignore-this: e9e0b7e0163f1e95858aa646b9b17b8c
475]
476[prepare for viz: improve DownloadStatus events
477Brian Warner <warner@lothar.com>**20110629222542
478 Ignore-this: 16d0bde6b734bb501aa6f1174b2b57be
479 
480 consolidate IDownloadStatusHandlingConsumer stuff into DownloadNode
481]
482[docs: fix error in crypto specification that was noticed by Taylor R Campbell <campbell+tahoe@mumble.net>
483zooko@zooko.com**20110629185711
484 Ignore-this: b921ed60c1c8ba3c390737fbcbe47a67
485]
486[setup.py: don't make bin/tahoe.pyscript executable. fixes #1347
487david-sarah@jacaranda.org**20110130235809
488 Ignore-this: 3454c8b5d9c2c77ace03de3ef2d9398a
489]
490[Makefile: remove targets relating to 'setup.py check_auto_deps' which no longer exists. fixes #1345
491david-sarah@jacaranda.org**20110626054124
492 Ignore-this: abb864427a1b91bd10d5132b4589fd90
493]
494[Makefile: add 'make check' as an alias for 'make test'. Also remove an unnecessary dependency of 'test' on 'build' and 'src/allmydata/_version.py'. fixes #1344
495david-sarah@jacaranda.org**20110623205528
496 Ignore-this: c63e23146c39195de52fb17c7c49b2da
497]
498[Rename test_package_initialization.py to (much shorter) test_import.py .
499Brian Warner <warner@lothar.com>**20110611190234
500 Ignore-this: 3eb3dbac73600eeff5cfa6b65d65822
501 
502 The former name was making my 'ls' listings hard to read, by forcing them
503 down to just two columns.
504]
505[tests: fix tests to accomodate [20110611153758-92b7f-0ba5e4726fb6318dac28fb762a6512a003f4c430]
506zooko@zooko.com**20110611163741
507 Ignore-this: 64073a5f39e7937e8e5e1314c1a302d1
508 Apparently none of the two authors (stercor, terrell), three reviewers (warner, davidsarah, terrell), or one committer (me) actually ran the tests. This is presumably due to #20.
509 fixes #1412
510]
511[wui: right-align the size column in the WUI
512zooko@zooko.com**20110611153758
513 Ignore-this: 492bdaf4373c96f59f90581c7daf7cd7
514 Thanks to Ted "stercor" Rolle Jr. and Terrell Russell.
515 fixes #1412
516]
517[docs: three minor fixes
518zooko@zooko.com**20110610121656
519 Ignore-this: fec96579eb95aceb2ad5fc01a814c8a2
520 CREDITS for arc for stats tweak
521 fix link to .zip file in quickstart.rst (thanks to ChosenOne for noticing)
522 English usage tweak
523]
524[docs/running.rst: fix stray HTML (not .rst) link noticed by ChosenOne.
525david-sarah@jacaranda.org**20110609223719
526 Ignore-this: fc50ac9c94792dcac6f1067df8ac0d4a
527]
528[server.py:  get_latencies now reports percentiles _only_ if there are sufficient observations for the interpretation of the percentile to be unambiguous.
529wilcoxjg@gmail.com**20110527120135
530 Ignore-this: 2e7029764bffc60e26f471d7c2b6611e
531 interfaces.py:  modified the return type of RIStatsProvider.get_stats to allow for None as a return value
532 NEWS.rst, stats.py: documentation of change to get_latencies
533 stats.rst: now documents percentile modification in get_latencies
534 test_storage.py:  test_latencies now expects None in output categories that contain too few samples for the associated percentile to be unambiguously reported.
535 fixes #1392
536]
537[docs: revert link in relnotes.txt from NEWS.rst to NEWS, since the former did not exist at revision 5000.
538david-sarah@jacaranda.org**20110517011214
539 Ignore-this: 6a5be6e70241e3ec0575641f64343df7
540]
541[docs: convert NEWS to NEWS.rst and change all references to it.
542david-sarah@jacaranda.org**20110517010255
543 Ignore-this: a820b93ea10577c77e9c8206dbfe770d
544]
545[docs: remove out-of-date docs/testgrid/introducer.furl and containing directory. fixes #1404
546david-sarah@jacaranda.org**20110512140559
547 Ignore-this: 784548fc5367fac5450df1c46890876d
548]
549[scripts/common.py: don't assume that the default alias is always 'tahoe' (it is, but the API of get_alias doesn't say so). refs #1342
550david-sarah@jacaranda.org**20110130164923
551 Ignore-this: a271e77ce81d84bb4c43645b891d92eb
552]
553[setup: don't catch all Exception from check_requirement(), but only PackagingError and ImportError
554zooko@zooko.com**20110128142006
555 Ignore-this: 57d4bc9298b711e4bc9dc832c75295de
556 I noticed this because I had accidentally inserted a bug which caused AssertionError to be raised from check_requirement().
557]
558[M-x whitespace-cleanup
559zooko@zooko.com**20110510193653
560 Ignore-this: dea02f831298c0f65ad096960e7df5c7
561]
562[docs: fix typo in running.rst, thanks to arch_o_median
563zooko@zooko.com**20110510193633
564 Ignore-this: ca06de166a46abbc61140513918e79e8
565]
566[relnotes.txt: don't claim to work on Cygwin (which has been untested for some time). refs #1342
567david-sarah@jacaranda.org**20110204204902
568 Ignore-this: 85ef118a48453d93fa4cddc32d65b25b
569]
570[relnotes.txt: forseeable -> foreseeable. refs #1342
571david-sarah@jacaranda.org**20110204204116
572 Ignore-this: 746debc4d82f4031ebf75ab4031b3a9
573]
574[replace remaining .html docs with .rst docs
575zooko@zooko.com**20110510191650
576 Ignore-this: d557d960a986d4ac8216d1677d236399
577 Remove install.html (long since deprecated).
578 Also replace some obsolete references to install.html with references to quickstart.rst.
579 Fix some broken internal references within docs/historical/historical_known_issues.txt.
580 Thanks to Ravi Pinjala and Patrick McDonald.
581 refs #1227
582]
583[docs: FTP-and-SFTP.rst: fix a minor error and update the information about which version of Twisted fixes #1297
584zooko@zooko.com**20110428055232
585 Ignore-this: b63cfb4ebdbe32fb3b5f885255db4d39
586]
587[munin tahoe_files plugin: fix incorrect file count
588francois@ctrlaltdel.ch**20110428055312
589 Ignore-this: 334ba49a0bbd93b4a7b06a25697aba34
590 fixes #1391
591]
592[corrected "k must never be smaller than N" to "k must never be greater than N"
593secorp@allmydata.org**20110425010308
594 Ignore-this: 233129505d6c70860087f22541805eac
595]
596[Fix a test failure in test_package_initialization on Python 2.4.x due to exceptions being stringified differently than in later versions of Python. refs #1389
597david-sarah@jacaranda.org**20110411190738
598 Ignore-this: 7847d26bc117c328c679f08a7baee519
599]
600[tests: add test for including the ImportError message and traceback entry in the summary of errors from importing dependencies. refs #1389
601david-sarah@jacaranda.org**20110410155844
602 Ignore-this: fbecdbeb0d06a0f875fe8d4030aabafa
603]
604[allmydata/__init__.py: preserve the message and last traceback entry (file, line number, function, and source line) of ImportErrors in the package versions string. fixes #1389
605david-sarah@jacaranda.org**20110410155705
606 Ignore-this: 2f87b8b327906cf8bfca9440a0904900
607]
608[remove unused variable detected by pyflakes
609zooko@zooko.com**20110407172231
610 Ignore-this: 7344652d5e0720af822070d91f03daf9
611]
612[allmydata/__init__.py: Nicer reporting of unparseable version numbers in dependencies. fixes #1388
613david-sarah@jacaranda.org**20110401202750
614 Ignore-this: 9c6bd599259d2405e1caadbb3e0d8c7f
615]
616[update FTP-and-SFTP.rst: the necessary patch is included in Twisted-10.1
617Brian Warner <warner@lothar.com>**20110325232511
618 Ignore-this: d5307faa6900f143193bfbe14e0f01a
619]
620[control.py: remove all uses of s.get_serverid()
621warner@lothar.com**20110227011203
622 Ignore-this: f80a787953bd7fa3d40e828bde00e855
623]
624[web: remove some uses of s.get_serverid(), not all
625warner@lothar.com**20110227011159
626 Ignore-this: a9347d9cf6436537a47edc6efde9f8be
627]
628[immutable/downloader/fetcher.py: remove all get_serverid() calls
629warner@lothar.com**20110227011156
630 Ignore-this: fb5ef018ade1749348b546ec24f7f09a
631]
632[immutable/downloader/fetcher.py: fix diversity bug in server-response handling
633warner@lothar.com**20110227011153
634 Ignore-this: bcd62232c9159371ae8a16ff63d22c1b
635 
636 When blocks terminate (either COMPLETE or CORRUPT/DEAD/BADSEGNUM), the
637 _shares_from_server dict was being popped incorrectly (using shnum as the
638 index instead of serverid). I'm still thinking through the consequences of
639 this bug. It was probably benign and really hard to detect. I think it would
640 cause us to incorrectly believe that we're pulling too many shares from a
641 server, and thus prefer a different server rather than asking for a second
642 share from the first server. The diversity code is intended to spread out the
643 number of shares simultaneously being requested from each server, but with
644 this bug, it might be spreading out the total number of shares requested at
645 all, not just simultaneously. (note that SegmentFetcher is scoped to a single
646 segment, so the effect doesn't last very long).
647]
648[immutable/downloader/share.py: reduce get_serverid(), one left, update ext deps
649warner@lothar.com**20110227011150
650 Ignore-this: d8d56dd8e7b280792b40105e13664554
651 
652 test_download.py: create+check MyShare instances better, make sure they share
653 Server objects, now that finder.py cares
654]
655[immutable/downloader/finder.py: reduce use of get_serverid(), one left
656warner@lothar.com**20110227011146
657 Ignore-this: 5785be173b491ae8a78faf5142892020
658]
659[immutable/offloaded.py: reduce use of get_serverid() a bit more
660warner@lothar.com**20110227011142
661 Ignore-this: b48acc1b2ae1b311da7f3ba4ffba38f
662]
663[immutable/upload.py: reduce use of get_serverid()
664warner@lothar.com**20110227011138
665 Ignore-this: ffdd7ff32bca890782119a6e9f1495f6
666]
667[immutable/checker.py: remove some uses of s.get_serverid(), not all
668warner@lothar.com**20110227011134
669 Ignore-this: e480a37efa9e94e8016d826c492f626e
670]
671[add remaining get_* methods to storage_client.Server, NoNetworkServer, and
672warner@lothar.com**20110227011132
673 Ignore-this: 6078279ddf42b179996a4b53bee8c421
674 MockIServer stubs
675]
676[upload.py: rearrange _make_trackers a bit, no behavior changes
677warner@lothar.com**20110227011128
678 Ignore-this: 296d4819e2af452b107177aef6ebb40f
679]
680[happinessutil.py: finally rename merge_peers to merge_servers
681warner@lothar.com**20110227011124
682 Ignore-this: c8cd381fea1dd888899cb71e4f86de6e
683]
684[test_upload.py: factor out FakeServerTracker
685warner@lothar.com**20110227011120
686 Ignore-this: 6c182cba90e908221099472cc159325b
687]
688[test_upload.py: server-vs-tracker cleanup
689warner@lothar.com**20110227011115
690 Ignore-this: 2915133be1a3ba456e8603885437e03
691]
692[happinessutil.py: server-vs-tracker cleanup
693warner@lothar.com**20110227011111
694 Ignore-this: b856c84033562d7d718cae7cb01085a9
695]
696[upload.py: more tracker-vs-server cleanup
697warner@lothar.com**20110227011107
698 Ignore-this: bb75ed2afef55e47c085b35def2de315
699]
700[upload.py: fix var names to avoid confusion between 'trackers' and 'servers'
701warner@lothar.com**20110227011103
702 Ignore-this: 5d5e3415b7d2732d92f42413c25d205d
703]
704[refactor: s/peer/server/ in immutable/upload, happinessutil.py, test_upload
705warner@lothar.com**20110227011100
706 Ignore-this: 7ea858755cbe5896ac212a925840fe68
707 
708 No behavioral changes, just updating variable/method names and log messages.
709 The effects outside these three files should be minimal: some exception
710 messages changed (to say "server" instead of "peer"), and some internal class
711 names were changed. A few things still use "peer" to minimize external
712 changes, like UploadResults.timings["peer_selection"] and
713 happinessutil.merge_peers, which can be changed later.
714]
715[storage_client.py: clean up test_add_server/test_add_descriptor, remove .test_servers
716warner@lothar.com**20110227011056
717 Ignore-this: efad933e78179d3d5fdcd6d1ef2b19cc
718]
719[test_client.py, upload.py:: remove KiB/MiB/etc constants, and other dead code
720warner@lothar.com**20110227011051
721 Ignore-this: dc83c5794c2afc4f81e592f689c0dc2d
722]
723[test: increase timeout on a network test because Francois's ARM machine hit that timeout
724zooko@zooko.com**20110317165909
725 Ignore-this: 380c345cdcbd196268ca5b65664ac85b
726 I'm skeptical that the test was proceeding correctly but ran out of time. It seems more likely that it had gotten hung. But if we raise the timeout to an even more extravagant number then we can be even more certain that the test was never going to finish.
727]
728[docs/configuration.rst: add a "Frontend Configuration" section
729Brian Warner <warner@lothar.com>**20110222014323
730 Ignore-this: 657018aa501fe4f0efef9851628444ca
731 
732 this points to docs/frontends/*.rst, which were previously underlinked
733]
734[web/filenode.py: avoid calling req.finish() on closed HTTP connections. Closes #1366
735"Brian Warner <warner@lothar.com>"**20110221061544
736 Ignore-this: 799d4de19933f2309b3c0c19a63bb888
737]
738[Add unit tests for cross_check_pkg_resources_versus_import, and a regression test for ref #1355. This requires a little refactoring to make it testable.
739david-sarah@jacaranda.org**20110221015817
740 Ignore-this: 51d181698f8c20d3aca58b057e9c475a
741]
742[allmydata/__init__.py: .name was used in place of the correct .__name__ when printing an exception. Also, robustify string formatting by using %r instead of %s in some places. fixes #1355.
743david-sarah@jacaranda.org**20110221020125
744 Ignore-this: b0744ed58f161bf188e037bad077fc48
745]
746[Refactor StorageFarmBroker handling of servers
747Brian Warner <warner@lothar.com>**20110221015804
748 Ignore-this: 842144ed92f5717699b8f580eab32a51
749 
750 Pass around IServer instance instead of (peerid, rref) tuple. Replace
751 "descriptor" with "server". Other replacements:
752 
753  get_all_servers -> get_connected_servers/get_known_servers
754  get_servers_for_index -> get_servers_for_psi (now returns IServers)
755 
756 This change still needs to be pushed further down: lots of code is now
757 getting the IServer and then distributing (peerid, rref) internally.
758 Instead, it ought to distribute the IServer internally and delay
759 extracting a serverid or rref until the last moment.
760 
761 no_network.py was updated to retain parallelism.
762]
763[TAG allmydata-tahoe-1.8.2
764warner@lothar.com**20110131020101]
765Patch bundle hash:
76614e3cad75e0aba6f2a1166df56d2b4ef6b838937