docs: move introduction sentence

This commit is contained in:
Marian Beermann 2017-06-19 10:01:55 +02:00
parent 52da719d30
commit d495b0fe75
2 changed files with 6 additions and 3 deletions

View File

@ -4,9 +4,8 @@
Internals Internals
========= =========
This page documents the internal data structures and storage The internals chapter describes and analyses most of the inner workings
mechanisms of |project_name|. It is partly based on `mailing list of Borg.
discussion about internals`_ and also on static code analysis.
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

View File

@ -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?),