Commit Graph

199 Commits

Author SHA1 Message Date
Jean-Paul Calderone
4e6077fae1 Nope, actually it doesn't. It uses ~/.tahoe. 2020-12-09 10:50:03 -05:00
Jean-Paul Calderone
9fe3dddac4 use "tahoe run" 2020-12-09 10:50:03 -05:00
Jean-Paul Calderone
e3a6d75962
Remove the obvious documentation references 2020-02-13 10:23:27 -05:00
meejah
44cddc2ee3 conch doesn't require cryptopp any more
(as per exarkun review-comment)
2019-06-24 11:23:54 -06:00
meejah
78a13aad43 cryptography back into docs 2019-06-13 22:19:28 -06:00
heartsucker
b6da2cb6e8 remove references to pycryptopp from docs 2019-06-13 22:18:55 -06:00
meejah
9375056b61 Split up startstop_node and add 'tahoe daemonize'
This sets the stage for further changes to the startup
process so that "async things" are done before we create
the Client instance while still reporting early failures
to the shell where "tahoe start" is running

Also adds a bunch of test-coverage for the things that got
moved around, even though they didn't have coverage before
2017-09-19 10:39:19 -06:00
Jean-Paul Calderone
1f16a173f0 flatten the result structure
flat is better than nested
2017-07-27 15:32:47 -04:00
Jean-Paul Calderone
e0ee726d22 Update to the format the code now actually produces 2017-07-27 15:28:29 -04:00
Jean-Paul Calderone
780a932122 consistent markup 2017-07-27 15:26:30 -04:00
Jean-Paul Calderone
7b88cf376b remove duplicate "above" 2017-07-27 15:26:30 -04:00
Jean-Paul Calderone
cc0e6ea6f9 typo fix 2017-07-27 15:26:30 -04:00
David Stainton
2006e6ae41 docs: add explaination of json welcome fields 2017-07-27 15:26:29 -04:00
David Stainton
a87822e66b Add note about json welcome page to api docs 2017-07-27 15:26:29 -04:00
Brian Warner
705dc856eb grammatical improvements 2017-06-06 11:28:23 +01:00
Daira Hopwood
2055a66cf2 Doc changes that require more careful review. refs #2345
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2017-06-06 11:20:49 +01:00
Daira Hopwood
4723af6e2f LAFS now stands for "Least-Authority File Store" rather than "Least-Authority File System". refs #2345
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2017-06-06 11:20:49 +01:00
Vladimir Rusinov
b7e76c7f24 Document api-version field for deep-stats. 2016-12-23 22:50:48 -05:00
Brian Warner
91047bf828 docs: clean up .rst and references
This uses Read-The-Docs (sphinx/docutils) references exclusively, but adds a
README.md for GitHub viewers to remind them that the links there won't
work (closes ticket:2835).

It also fixes all the dangling references and other Sphinx warnings.

The "Preparation" section of docs/magic-folder-howto.rst was removed, since
this feature has since been merged to trunk.
2016-12-12 13:57:28 -08:00
Brian Warner
8d9afdc27e CLI: remove 'debug trial', 'debug repl'
These are obsolete. Tests are run with 'tox', or by running 'trial
allmydata' from a populated virtualenv. A populated virtualenv is also
the right way to get a repl: just run 'python'.

refs ticket:2735
2016-09-09 15:37:28 -07:00
Daira Hopwood
abb2d6f9a9 More Magic Folder doc updates.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-21 12:35:59 -07:00
Daira Hopwood
1033c6f0c6 Magic Folder doc updates.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-21 12:35:59 -07:00
Daira Hopwood
815a50df71 magic-folder.rst: remove "Known Issues and Limitations" that have been fixed.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-21 12:35:59 -07:00
Daira Hopwood
2f6ca5d3da magic-folder.rst: update introduction.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-21 12:35:59 -07:00
David Stainton
bc6fcc2901 Include brief summary of magic-folder CLI commands 2016-07-21 12:35:59 -07:00
David Stainton
09414bb379 Add link to our cli design doc 2016-07-21 12:35:59 -07:00
David Stainton
ddded9a026 Mention gc is not part of the otf grant and link to the gc ticket 2016-07-21 12:35:59 -07:00
David Stainton
97a1322378 Remove old obsolete/inaccurate statements 2016-07-21 12:35:59 -07:00
Daira Hopwood
1495d0f405 Documentation changes for Magic Folder.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-21 12:35:59 -07:00
Daira Hopwood
54371547db Docs for drop-upload on Windows.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-21 12:35:59 -07:00
Brian Warner
d1d988410b remove "key-generator" node type and client support
closes ticket:2783
2016-05-04 16:53:04 -07:00
Brian Warner
c582a21e99 webapi.rst: fixups
Re-indent the blocks for consistency, improve the explanation of
?filename=foo.jpg to match it's new location, use new-style reference
for urls-and-utf8 footnote.
2016-04-22 19:23:49 -07:00
Zooko O'Whielacronx
3e7346100f update webapi.rst's View/Download File docs
• mark "/file/" as a synonym for "/named/" to be deprecated (fixes #1903)
• move the options common to all three forms to the bottom and dedent them
• name the protocol/format as "LAFS" and the implementation/client "Tahoe"
• reflow (with fill-column 77)
2016-04-22 19:17:22 -07:00
Brian Warner
f81900ee35 format docs for Sphinx
Added indexes, fixed cross-references.

Also a few pip-related cleanups I noticed along the way.
2016-03-30 01:26:47 -07:00
Brian Warner
259ba07a5e improve HTTP byte-range docs 2015-07-28 13:28:36 -07:00
Brian Warner
c3608f61d9 webapi.rst: document Range: header on GET requests
closes ticket#2460
2015-07-28 13:15:50 -07:00
Daira Hopwood
aa65426ad3 docs/frontends/CLI.rst: clarification.
The implementation (in [source:src/allmydata/scripts/common.py]) actually tests whether there is a slash anywhere before the first colon.

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-05-11 15:05:42 +01:00
Daira Hopwood
7ee151fa55 docs/frontends/CLI.rst: remove a superfluous TODO.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-05-11 14:50:32 +01:00
Brian Warner
97fd19407d Improve docs on 'cp -r', noting the recent 2329 changes
refs ticket:2329
2015-05-03 21:49:34 -07:00
Daira Hopwood
0d935e8589 Update docs for SFTP public key auth. refs #1411
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-01-06 19:14:47 +00:00
Brian Warner
2018ff435a CLI.rst: expand the 'cp -r' subdirectory example 2014-09-02 12:51:13 -07:00
Mark J. Berger
58106e1c0f Documentation updates 2014-09-02 12:51:13 -07:00
Zooko Wilcox-O'Hearn
35e90006f4 recommend tahoe backup
and, explain some of why it is awesome, and link to
`<docs/frontends/CLI.rst>`__.
2014-08-19 18:18:33 +00:00
zooko
bc6304ae70 Merge pull request #94 from zooko/link-to-Twisted-ticket-4633
link to Twisted ticket #4633
2014-07-22 06:27:25 +00:00
Zooko Wilcox-O'Hearn
78503591d7 link to Twisted ticket #4633 2014-07-22 05:16:04 +00:00
pataquets
fac1f0d55a Update adding comments as seen in https://tahoe-lafs.org/pipermail/tahoe-dev/2012-May/007365.html
Found it useful. I can't see here clearly if deleting backupdb will affect deduplication and I'd like to clarify here, anyway. Do deduplication depend on backupdb data? TIA.
2014-07-02 13:10:10 -07:00
Daira Hopwood
0ef5939477 Remove 'needs-rebalancing' and add 'count-happiness' to checker reports; repair tests. fixes #1784, #2105
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2014-03-20 16:13:57 +00:00
Zooko Wilcox-O'Hearn
0bebbe3290 fix warnings from rst2html
Apparently the in-line link syntax with "<>" in them causes these warnings. I
don't know why. I changed them all to a slightly more verbose syntax.

Thanks to Mike Kazantzsev's review comment
(https://github.com/tahoe-lafs/tahoe-lafs/pull/67#commitcomment-4561370), I
moved the links to the end of each section.
2013-11-11 22:04:11 +00:00
Zooko Wilcox-O'Hearn
82579cec96 magic first line tells emacs to use utf8+bom
Add ".. -*- coding: utf-8-with-signature -*-" to the first line of each .rst
file. This tells emacs to treat the file contents as utf-8, and also to prepend
a so-called utf-8 "bom" marker at the beginning of the file. This patch also
prepends those markers to each of those files.
2013-11-08 21:08:05 +00:00
Daira Hopwood
b06f8cd8d0 Add comments and a caveat in webapi.rst indicating that
the needs-rebalancing field may be computed incorrectly. refs #1115, #1784, #1477

Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2013-04-18 23:48:45 +01:00