From b7c26735f77a228fd38ecb931ddb8b42b25178e6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antoine=20Beaupr=C3=A9?= Date: Tue, 16 Dec 2014 10:59:02 -0500 Subject: [PATCH] fix formatting issues --- docs/global.rst.inc | 5 +---- docs/internals.rst | 18 +++++++++--------- 2 files changed, 10 insertions(+), 13 deletions(-) diff --git a/docs/global.rst.inc b/docs/global.rst.inc index 72d15126f..08e548012 100644 --- a/docs/global.rst.inc +++ b/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/ diff --git a/docs/internals.rst b/docs/internals.rst index 585266a9a..9d6d8b7ac 100644 --- a/docs/internals.rst +++ b/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.