Antoine Beaupré пре 10 година
родитељ
комит
b7c26735f7
2 измењених фајлова са 10 додато и 13 уклоњено
  1. 1 4
      docs/global.rst.inc
  2. 9 9
      docs/internals.rst

+ 1 - 4
docs/global.rst.inc

@@ -7,16 +7,13 @@
 .. _deduplication: https://en.wikipedia.org/wiki/Data_deduplication
 .. _AES: https://en.wikipedia.org/wiki/Advanced_Encryption_Standard
 .. _HMAC-SHA256: http://en.wikipedia.org/wiki/HMAC
+.. _SHA256: https://en.wikipedia.org/wiki/SHA-256
 .. _PBKDF2: https://en.wikipedia.org/wiki/PBKDF2
 .. _ACL: https://en.wikipedia.org/wiki/Access_control_list
 .. _github: https://github.com/jborg/attic
 .. _OpenSSL: https://www.openssl.org/
 .. _Python: http://www.python.org/
 .. _Buzhash: https://en.wikipedia.org/wiki/Buzhash
-.. _PBKDF2: https://en.wikipedia.org/wiki/PBKDF2
-.. _SHA256: https://en.wikipedia.org/wiki/SHA-256
-.. _HMAC: https://en.wikipedia.org/wiki/HMAC
-.. _AES: https://en.wikipedia.org/wiki/AES
 .. _msgpack: http://msgpack.org/
 .. _`msgpack-python`: https://pypi.python.org/pypi/msgpack-python/
 .. _llfuse: https://pypi.python.org/pypi/llfuse/

+ 9 - 9
docs/internals.rst

@@ -37,13 +37,13 @@ Repository config file
 ----------------------
 
 Each repository has a ``config`` file which which is a ``INI``
-formatted file which looks like this:
+formatted file which looks like this::
 
-  [repository]
-  version = 1
-  segments_per_dir = 10000
-  max_segment_size = 5242880
-  id = 57d6c1d52ce76a836b532b0e42e677dec6af9fca3673db511279358828a21ed6
+    [repository]
+    version = 1
+    segments_per_dir = 10000
+    max_segment_size = 5242880
+    id = 57d6c1d52ce76a836b532b0e42e677dec6af9fca3673db511279358828a21ed6
 
 This is where the ``repository.id`` is stored. It is a unique
 identifier for repositories. It will not change if you move the
@@ -309,6 +309,6 @@ data
   described above
 
 The resulting msgpack_ is then encoded using base64 and written to the
-key file, wrapped using the textwrap_ module with a header. The header
-is a single line with the string ``ATTIC_KEY``, a space and a
-hexadecimal representation of the repository id.
+key file, wrapped using the builtin ``textwrap`` module with a
+header. The header is a single line with the string ``ATTIC_KEY``, a
+space and a hexadecimal representation of the repository id.