Commit Graph

675 Commits

Author SHA1 Message Date
Zooko O'Whielacronx
155d048d17 docs: three minor fixes
CREDITS for arc for stats tweak
fix link to .zip file in quickstart.rst (thanks to ChosenOne for noticing)
English usage tweak
2011-06-10 05:16:56 -07:00
david-sarah
ff136b8ed2 docs/running.rst: fix stray HTML (not .rst) link noticed by ChosenOne. 2011-06-09 15:37:19 -07:00
wilcoxjg
67ad0175cd server.py: get_latencies now reports percentiles _only_ if there are sufficient observations for the interpretation of the percentile to be unambiguous.
interfaces.py:  modified the return type of RIStatsProvider.get_stats to allow for None as a return value
NEWS.rst, stats.py: documentation of change to get_latencies
stats.rst: now documents percentile modification in get_latencies
test_storage.py:  test_latencies now expects None in output categories that contain too few samples for the associated percentile to be unambiguously reported.
fixes #1392
2011-05-27 05:01:35 -07:00
secorp
d566e4632d corrected "k must never be smaller than N" to "k must never be greater than N" 2011-04-24 18:03:08 -07:00
david-sarah
a817163cc6 docs: convert NEWS to NEWS.rst and change all references to it. 2011-05-16 18:02:55 -07:00
david-sarah
435dcfd6ff docs: remove out-of-date docs/testgrid/introducer.furl and containing directory. fixes #1404 2011-05-12 07:05:59 -07:00
Zooko O'Whielacronx
f251bbece5 M-x whitespace-cleanup 2011-05-10 12:36:53 -07:00
Zooko O'Whielacronx
9619812a9d docs: fix typo in running.rst, thanks to arch_o_median 2011-05-10 12:36:33 -07:00
Zooko O'Whielacronx
299e8ad579 replace remaining .html docs with .rst docs
Remove install.html (long since deprecated).
Also replace some obsolete references to install.html with references to quickstart.rst.
Fix some broken internal references within docs/historical/historical_known_issues.txt.
Thanks to Ravi Pinjala and Patrick McDonald.
refs #1227
2011-05-10 12:16:50 -07:00
Zooko O'Whielacronx
02cfdd2f03 docs: FTP-and-SFTP.rst: fix a minor error and update the information about which version of Twisted fixes #1297 2011-04-27 22:52:32 -07:00
Brian Warner
2b9d333835 update FTP-and-SFTP.rst: the necessary patch is included in Twisted-10.1 2011-03-25 16:25:11 -07:00
Brian Warner
0f3fe54530 docs/configuration.rst: add a "Frontend Configuration" section
this points to docs/frontends/*.rst, which were previously underlinked
2011-02-21 17:43:23 -08:00
Brian Warner
7a4f76fd90 update docs for the 1.8.2 release 2011-01-30 17:59:45 -08:00
Zooko O'Whielacronx
c1ec785b48 docs: edit running.html, change "http://allmydata.org" to "http://tahoe-lafs.org" in NEWS and README.txt, add Josh Wilcox to CREDITS for his contribution of doc patches 2011-01-28 07:07:00 -08:00
david-sarah
5299db9c04 docs/configuration.rst: fix a typo in the previous correction, and correct another error ('[storage]readonly_storage' should be '[storage]readonly'). 2011-01-22 18:39:55 -08:00
david-sarah
41753dc42d docs/configuration.rst: correct an error in the Example section ('[helper]run_helper' should be '[helper]enabled'). 2011-01-22 18:23:04 -08:00
david-sarah
0f818d7cc4 docs/configuration.rst: correct the name of 'tahoe-client.tac' and document other .tac files. Also make the capitalization consistent in that section. 2011-01-22 18:00:11 -08:00
david-sarah
3eadc8a053 NEWS, docs/quickstart.html: pywin32 is no longer required on Windows. refs #1274 2011-01-21 18:47:41 -08:00
david-sarah
a9fc4668c0 docs/frontends/CLI.rst, src/allmydata/test/trialtest.py: add trailing newlines. refs #1296 2011-01-19 00:19:55 -08:00
david-sarah
bbc1f56981 Documentation for 'tahoe debug trial' (rebased for trunk). refs #1296 2011-01-18 12:57:29 -08:00
david-sarah
f10a2c0902 CLI: make 'tahoe create-alias' and 'tahoe add-alias' accept a trailing colon on the new alias name (v2, minor change not to rely on implicit Unicode conversion). Includes doc changes and news; tests in a separate patch. fixes #1305 2011-01-13 19:44:14 -08:00
Brian Warner
45212d8000 Set "reserved_space=1G" in newly-created storage nodes. Closes #1208. 2011-01-16 12:58:22 -08:00
david-sarah
feed9977a9 docs/frontends/CLI.rst: fix the rst syntax to be as actually intended :-) 2011-01-08 17:40:57 -08:00
david-sarah
6c45f4d238 docs/frontends/CLI.rst: really fix rst syntax error this time. 2011-01-08 17:39:14 -08:00
david-sarah
98e2b15e3b docs/frontends/CLI.rst: fix rst syntax error. 2011-01-08 17:09:43 -08:00
david-sarah
6ce3ec6d0d docs/frontends/CLI.rst: discuss commandline/output quoting issues and wildcards. refs #1135 2011-01-08 17:01:19 -08:00
david-sarah
2b5b285dab docs/FTP-and-SFTP.rst: document issue in ref #1297. Remove known issue #1045 which is fixed. Also some cosmetic changes. 2011-01-07 22:10:38 -08:00
Zooko O'Whielacronx
3523b50716 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" 2011-01-03 22:54:55 -08:00
david-sarah
6e0308be30 docs/quickstart.html: fix redundant, badly nested tag. refs #1284 2011-01-02 09:51:59 -08:00
david-sarah
4aec2e1e02 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 2011-01-02 09:42:12 -08:00
david-sarah
be18ded062 docs/webapi.rst: typos. 2010-12-29 19:44:22 -08:00
david-sarah
53aeb3a3bc docs/webapi.rst: capitalization, formatting of section on URL character encoding, and a correction about Internet Explorer. 2010-12-29 19:40:49 -08:00
david-sarah
83f97dcf7d docs: corrections and clarifications. 2010-12-26 21:10:56 -08:00
david-sarah
45dd8b910a docs: more formatting cleanups and corrections. Spell webapi and wapi as web-API. 2010-12-26 21:05:33 -08:00
david-sarah
7be2c73f08 docs/debian.rst: bring description of building dependencies from source up-to-date, and change hostname from allmydata.com to tahoe-lafs.org. 2010-12-12 14:29:12 -08:00
david-sarah
382b595d9e docs/architecture.rst: correct rst syntax. 2010-12-12 12:20:03 -08:00
david-sarah
13bdf3a43d docs/architecture.rst: formatting. 2010-12-12 12:17:19 -08:00
david-sarah
5c4ed235de docs: linkification, wording improvements. 2010-12-12 12:12:34 -08:00
david-sarah
a86724ccd8 docs: formatting. 2010-12-12 12:11:15 -08:00
david-sarah
dfd9c8a949 docs/configuration.rst: more formatting tweaks; which -> that. 2010-12-12 11:55:22 -08:00
david-sarah
43ebdbb87d docs/configuration.rst: more changes to formatting. 2010-12-12 11:45:11 -08:00
david-sarah
50b8a89c00 docs/configuration.rst: changes to formatting (mainly putting commands and filenames in monospace). 2010-12-12 10:18:28 -08:00
david-sarah
a02e871e7f 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. 2010-12-12 08:58:00 -08:00
david-sarah
c90fd96538 docs/frontends/CLI.rst: Unicode arguments to 'tahoe' work on Windows as of v1.7.1. 2010-12-11 22:37:40 -08:00
david-sarah
e35cbb7aef docs/known_issues.rst: fix title and linkify another URL. refs #1225 2010-12-11 22:28:17 -08:00
david-sarah
64a4ef5966 docs/known_issues.rst: fix an external link. refs #1225 2010-12-11 22:24:35 -08:00
david-sarah
5f73c27b23 Fix a link from uri.rst to dirnodes.rst. refs #1225 2010-12-11 21:45:02 -08:00
david-sarah
341cad80ff Fix a link from webapi.rst to FTP-and-SFTP.rst. refs #1225 2010-12-11 21:34:35 -08:00
david-sarah
5ce5faf0af More specific hyperlink to architecture.rst from helper.rst. refs #1225 2010-12-11 21:26:07 -08:00
david-sarah
5d612c87ab Update hyperlinks between docs, and linkify some external references. refs #1225 2010-12-11 21:14:59 -08:00
david-sarah
458b2de08b docs/specifications/dirnodes.rst: fix references to mutable.rst. refs #1225 2010-12-11 17:27:20 -08:00
david-sarah
7da1885531 docs/specifications/mutable.rst: correct the magic string for v1 mutable containers. refs #1225 2010-12-11 17:14:00 -08:00
david-sarah
1d5c705201 Move .txt files in docs/frontends and docs/specifications to .rst. refs #1225 2010-12-11 17:02:51 -08:00
david-sarah
2100273ce3 Convert docs/frontends and docs/specifications to reStructuredText format (not including file moves). 2010-12-11 16:46:32 -08:00
david-sarah
940dd12227 quickstart.html: fix link to point to allmydata-tahoe-1.8.1.zip. 2010-11-28 14:17:28 -08:00
david-sarah
841dc76187 Release v1.8.1. refs #1242 2010-11-28 12:47:38 -08:00
Zooko O'Whielacronx
a4e9016482 docs: fix error in .rst formatting introduced by renaming Tahoe to Tahoe-LAFS in a header 2010-11-10 20:43:44 -08:00
Zooko O'Whielacronx
776eb31039 edit docs for English usage, rename "Tahoe" to "Tahoe-LAFS" in docs/configuration.rst, rename a variable in bin/tahoe-script.template for clarity, update François's CREDITS entry 2010-10-31 21:26:02 -07:00
david-sarah
5528af0524 docs/known_issues.rst: Add section on traffic analysis. Fix URL for current version of file. 2010-10-24 16:42:59 -07:00
david-sarah
679983bac6 docs/running.html: fix missing end-quote, and change frontends/ doc references to .rst. 2010-10-24 10:15:00 -07:00
david-sarah
1380fa9bb2 docs/running.html: 'tahoe create-client' now creates a node with storage disabled. Also change configuration.txt references to configuration.rst. 2010-10-24 10:04:31 -07:00
Zooko O'Whielacronx
9c01fdeb37 docs: update how-to-make-a-release doc with a few tweaks from the 1.8.0 process 2010-10-14 22:44:13 -07:00
Brian Warner
c4f8376a20 docs: fix tab-vs-spaces, make some CLI examples <tt>/"literal", wrap some to
80-cols, remove spurious whitespace. Add rst2html.py rule to Makefile.
2010-10-14 23:06:06 -07:00
Zooko O'Whielacronx
1e76d8ac39 docs: add Peter Secor, Shawn Willden, and Terrell Russell as signatories to docs/backdoors.rst 2010-10-14 22:32:42 -07:00
Zooko O'Whielacronx
8143183e39 docs: convert all .txt docs to .rst thanks to Ravi Pinjala
fixes #1225
2010-10-14 22:29:13 -07:00
Zooko O'Whielacronx
7c37292a09 docs: add statement on our refusal to insert backdoors 2010-10-05 22:11:47 -07:00
Zooko O'Whielacronx
6bf594ae13 docs: timestamp the 1.8.0 release 2010-09-23 19:15:52 -07:00
Zooko O'Whielacronx
2a5140b3b0 docs: update quickstart.html to include "In Case Of Trouble" and to mention Python 2.7 2010-09-23 19:08:51 -07:00
Zooko O'Whielacronx
79cfff8961 docs: mention default values of K, H, and M 2010-09-23 19:02:45 -07:00
david-sarah
41cee8a868 relnotes.txt and docs/quickstart.html for 1.8.0 release 2010-09-18 22:03:35 -07:00
david-sarah
3882692368 NEWS, docs/known_issues.txt for 1.8.0 release 2010-09-18 21:44:12 -07:00
Zooko O'Whielacronx
6eba4a2f8c docs: a few simple updates to links and naming, and also recommend torsocks instead of the old, unmaintained tsocks, for use with Tor 2010-09-18 18:16:36 -07:00
david-sarah
b86404e796 docs/quickstart.html: note dependency on python development files, e.g. on Ubuntu 2010-09-13 21:04:56 -07:00
Zooko O'Whielacronx
6b60525523 docs: update relnotes.txt, NEWS, and quickstart.html for the 1.8.0c4 release 2010-09-11 23:14:23 -07:00
david-sarah
31f66c5470 docs/frontends/webapi.txt: document that the meaning of the 'healthy' field may change in future to reflect servers-of-happiness; refs #614 2010-09-10 17:31:47 -07:00
david-sarah
0091205e3c docs/frontends/webapi.txt: note that 'count-good-share-hosts' is computed incorrectly; refs #1115 2010-09-10 17:25:48 -07:00
david-sarah
f32dddbced docs/frontends/FTP-and-SFTP.txt: docs/performance.txt, architecture.txt: updates taking into account new downloader (revised). refs #798 2010-09-10 12:54:22 -07:00
david-sarah
7d8e17c443 docs/frontends/FTP-and-SFTP.txt: warn users about connecting to the FTP and SFTP servers remotely. Fixes #1192 2010-09-10 12:32:34 -07:00
marc.doudiet
95c62dc238 docs/frontends/FTP-and-SFTP.txt : ftpd and sftpd doesn't listen on loopback interface only 2010-08-13 07:08:53 -07:00
Zooko O'Whielacronx
b6c559e009 docs: a couple of small edits to CREDITS and how_to_make_a_tahoe-lafs_release.txt 2010-08-29 15:27:58 -07:00
Zooko O'Whielacronx
36f698b637 docs: doc of the download status page
ref: http://tahoe-lafs.org/trac/tahoe-lafs/ticket/1169#comment:1
2010-08-13 22:41:17 -07:00
david-sarah
a3b4d76815 quickstart.html: update tarball link. 2010-08-10 00:38:32 -07:00
david-sarah
5872f6c8cf webapi.txt: fix grammatical error. 2010-08-09 23:41:27 -07:00
david-sarah
699eb25a78 NEWS, relnotes and known-issues for 1.8.0c2. 2010-08-09 23:28:51 -07:00
david-sarah
146c96d52e how_to_make_a_tahoe-lafs_release.txt: add step to check that release will report itself as the intended version. 2010-08-06 17:42:54 -07:00
david-sarah
0cb4903593 NEWS, quickstart.html and known_issues.txt for 1.8.0c1 release. 2010-08-06 16:51:11 -07:00
Brian Warner
25bee8ade6 update NEWS and other docs in preparation for 1.8.0rc1
in particular, merge the various 1.8.0b1/b2 sections, and remove the
datestamp. NEWS gets updated just before a release, doesn't need to precisely
describe pre-release candidates, and the datestamp gets updated just before
the final release is tagged

Also, I removed the BOM from some files. My toolchain made it hard to retain,
and BOMs in UTF-8 don't make a whole lot of sense anyway. Sorry if that
messes anything up.
2010-08-06 01:02:28 -07:00
david-sarah
077108bbe9 relnotes.txt and docs/known_issues.txt for 1.8.0beta2. 2010-08-05 21:08:23 -07:00
david-sarah
9fc6ab1183 NEWS and docs/quickstart.html for 1.8.0beta2. 2010-08-05 20:51:12 -07:00
david-sarah
5ad9a86bc7 docs/quickstart.html: remove link to tahoe-lafs-ticket798-1.8.0b.zip, due to appname regression. refs #1159 2010-08-05 17:24:35 -07:00
david-sarah
ebfde4f09f docs/quickstart.html: link to 1.8.0beta zip, and note 'bin\tahoe' on Windows. 2010-08-03 16:32:54 -07:00
david-sarah
74060f4ab8 docs/quickstart.html: extra step to open a new Command Prompt or log out/in on Windows. 2010-08-02 17:49:38 -07:00
Zooko O'Whielacronx
21daa70ee5 docs: update the list of forums to announce Tahoe-LAFS too, add empty checkboxes 2010-08-01 23:33:14 -07:00
david-sarah
e3b58b1e88 docs/specifications/dirnodes.txt: 'mesh'->'grid'. 2010-07-22 23:16:16 -07:00
david-sarah
497925317e docs/specifications/dirnodes.txt: bring layer terminology up-to-date with architecture.txt, and a few other updates (e.g. note that the MAC is no longer verified, and that URIs can be unknown). Also 'Tahoe'->'Tahoe-LAFS'. 2010-07-22 22:47:03 -07:00
david-sarah
ac29012946 docs/known_issues.txt: update release version and date. 2010-07-18 16:59:40 -07:00
david-sarah
09d35bf6b4 relnotes.txt, docs/quickstart.html: prepare for 1.7.1 release. Don't claim to work on Cygwin (this might work but is untested). 2010-07-18 16:54:37 -07:00
david-sarah
974f38eac9 docs/logging.txt: document that _trial_temp/test.log does not receive messages below level=OPERATIONAL, due to <http://foolscap.lothar.com/trac/ticket/154>. 2010-07-18 16:04:20 -07:00
jacob
ca660a5fc6 Debian documentation update 2010-03-04 18:30:04 -07:00
jacob
babbdf9494 debian-docs-patch-final 2010-03-04 02:59:55 -07:00