Browse Source

Merge pull request #2709 from enkore/docs/test

docs: move introduction sentence
enkore 8 years ago
parent
commit
4ebc907333
2 changed files with 6 additions and 3 deletions
  1. 2 3
      docs/internals.rst
  2. 4 0
      docs/internals/data-structures.rst

+ 2 - 3
docs/internals.rst

@@ -4,9 +4,8 @@
 Internals
 Internals
 =========
 =========
 
 
-This page documents the internal data structures and storage
-mechanisms of |project_name|. It is partly based on `mailing list
-discussion about internals`_ and also on static code analysis.
+The internals chapter describes and analyses most of the inner workings
+of Borg.
 
 
 Borg uses a low-level, key-value store, the :ref:`repository`, and
 Borg uses a low-level, key-value store, the :ref:`repository`, and
 implements a more complex data structure on top of it, which is made
 implements a more complex data structure on top of it, which is made

+ 4 - 0
docs/internals/data-structures.rst

@@ -6,6 +6,10 @@
 Data structures and file formats
 Data structures and file formats
 ================================
 ================================
 
 
+This page documents the internal data structures and storage
+mechanisms of Borg. It is partly based on `mailing list
+discussion about internals`_ and also on static code analysis.
+
 .. todo:: Clarify terms, perhaps create a glossary.
 .. todo:: Clarify terms, perhaps create a glossary.
           ID (client?) vs. key (repository?),
           ID (client?) vs. key (repository?),
           chunks (blob of data in repo?) vs. object (blob of data in repo, referred to from another object?),
           chunks (blob of data in repo?) vs. object (blob of data in repo, referred to from another object?),