Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

doc: about.rst: use unicode emdash, use non-embedded URIs, add clarif…

…icaiton of when a file gets its mutable-or-immutable nature

embedded URIs, although documented here:
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#embedded-uris
generate messages like this from rst2html --verbose:

quickstart.rst:3: (INFO/1) Duplicate explicit target name: "the tahoe-dev mailing list".

Also this patch prepends a "utf-8 BOM" to the beginning of the file.
  • Loading branch information...
commit 4a29642623196b4b9b965ecbd7697bb96e935c92 1 parent 37c0f23
zooko authored December 06, 2011

Showing 1 changed file with 31 additions and 23 deletions. Show diff stats Hide diff stats

  1. 54  docs/about.rst
54  docs/about.rst
Source Rendered
... ...
@@ -1,9 +1,11 @@
1  
-======================
  1
+======================
2 2
 Welcome to Tahoe-LAFS!
3 3
 ======================
4 4
 
5  
-Welcome to `Tahoe-LAFS <https://tahoe-lafs.org>`_, the first decentralized
6  
-storage system with *provider-independent security*.
  5
+Welcome to Tahoe-LAFS_, the first decentralized storage system with
  6
+*provider-independent security*.
  7
+
  8
+.. _Tahoe-LAFS: https://tahoe-lafs.org
7 9
 
8 10
 What is "provider-independent security"?
9 11
 ========================================
@@ -22,18 +24,18 @@ these service providers spend considerable effort and expense trying to
22 24
 mitigate these risks.
23 25
 
24 26
 What we mean by "security" is something different.  *The service provider
25  
-never has the ability to read or modify your data in the first place --
26  
-never.* If you use Tahoe-LAFS, then all of the threats described above are
27  
-non-issues to you.  Not only is it easy and inexpensive for the service
28  
-provider to maintain the security of your data, but in fact they couldn't
29  
-violate its security if they tried.  This is what we call
30  
-*provider-independent security*.
  27
+never has the ability to read or modify your data in the first place—never.*
  28
+If you use Tahoe-LAFS, then all of the threats described above are non-issues
  29
+to you.  Not only is it easy and inexpensive for the service provider to
  30
+maintain the security of your data, but in fact they couldn't violate its
  31
+security if they tried.  This is what we call *provider-independent
  32
+security*.
31 33
 
32 34
 This guarantee is integrated naturally into the Tahoe-LAFS storage system and
33 35
 doesn't require you to perform a manual pre-encryption step or cumbersome key
34 36
 management.  (After all, having to do cumbersome manual operations when
35 37
 storing or accessing your data would nullify one of the primary benefits of
36  
-using cloud storage in the first place -- convenience.)
  38
+using cloud storage in the first placeconvenience.)
37 39
 
38 40
 Here's how it works:
39 41
 
@@ -70,11 +72,12 @@ software installed, such as an Internet kiosk or cell phone.
70 72
 Access Control
71 73
 ==============
72 74
 
73  
-There are two kinds of files: immutable and mutable.  Immutable files have
74  
-the property that once they have been uploaded to the storage grid they can't
75  
-be modified.  Mutable ones can be modified.  A user can have read-write
76  
-access to a mutable file or read-only access to it (or no access to it at
77  
-all).
  75
+There are two kinds of files: immutable and mutable. When you upload a file
  76
+to the storage grid you can choose which kind of file it will be in the
  77
+grid. Immutable files can't be modified once they have been uploaded.  A
  78
+mutable file can be modified by someone with read-write access to it. A user
  79
+can have read-write access to a mutable file or read-only access to it, or no
  80
+access to it at all.
78 81
 
79 82
 A user who has read-write access to a mutable file or directory can give
80 83
 another user read-write access to that file or directory, or they can give
@@ -89,29 +92,34 @@ directory can gain read-only access to the child.  If you use a read-only
89 92
 link, then anyone who has either read-write or read-only access to the parent
90 93
 directory can gain read-only access to the child.
91 94
 
92  
-For more technical detail, please see the `the doc page
93  
-<https://tahoe-lafs.org/trac/tahoe-lafs/wiki/Doc>`_ on the Wiki.
  95
+For more technical detail, please see the `the doc page`_ on the Wiki.
  96
+
  97
+.. _the doc page: https://tahoe-lafs.org/trac/tahoe-lafs/wiki/Doc
94 98
 
95 99
 Get Started
96 100
 ===========
97 101
 
98  
-To use Tahoe-LAFS, please see `quickstart.rst <quickstart.rst>`_.
  102
+To use Tahoe-LAFS, please see quickstart.rst_.
  103
+
  104
+.. _quickstart.rst: quickstart.rst
99 105
 
100 106
 License
101 107
 =======
102 108
 
103 109
 You may use this package under the GNU General Public License, version 2 or,
104  
-at your option, any later version.  See the file `COPYING.GPL
105  
-<../COPYING.GPL>`_ for the terms of the GNU General Public License, version
106  
-2.
  110
+at your option, any later version.  See the file COPYING.GPL_ for the terms
  111
+of the GNU General Public License, version 2.
107 112
 
108 113
 You may use this package under the Transitive Grace Period Public Licence,
109 114
 version 1 or, at your option, any later version.  The Transitive Grace Period
110 115
 Public Licence has requirements similar to the GPL except that it allows you
111 116
 to wait for up to twelve months after you redistribute a derived work before
112  
-releasing the source code of your derived work. See the file `COPYING.TGGPL
113  
-<../COPYING.TGPPL.rst>`_ for the terms of the Transitive Grace Period Public
  117
+releasing the source code of your derived work. See the file
  118
+COPYING.TGPPL.rst_ for the terms of the Transitive Grace Period Public
114 119
 Licence, version 1.
115 120
 
116 121
 (You may choose to use this package under the terms of either licence, at
117 122
 your option.)
  123
+
  124
+.. _COPYING.GPL: ../COPYING.GPL
  125
+.. _COPYING.TGPPL.rst: ../COPYING.TGPPL.rst

0 notes on commit 4a29642

Please sign in to comment.
Something went wrong with that request. Please try again.