소스 검색

docs: installation: pre-install considerations, fix crossrefs

posix_fadvise -> only used when available; not part of the filesystem.
sync -> fsync
Marian Beermann 8 년 전
부모
커밋
e036ebc340
3개의 변경된 파일11개의 추가작업 그리고 4개의 파일을 삭제
  1. 5 4
      docs/installation.rst
  2. 4 0
      docs/internals/data-structures.rst
  3. 2 0
      docs/usage_general.rst.inc

+ 5 - 4
docs/installation.rst

@@ -27,7 +27,7 @@ Pre-Installation Considerations
 
 
 Repository File System
 Repository File System
 ~~~~~~~~~~~~~~~~~~~~~~
 ~~~~~~~~~~~~~~~~~~~~~~
-:ref:`data-structures-and-file-formats`
+
 - |project_name| stores data only 3 directory levels deep and uses short file and
 - |project_name| stores data only 3 directory levels deep and uses short file and
   directory names.
   directory names.
 - |project_name| requires read and write permissions on the repository file system.
 - |project_name| requires read and write permissions on the repository file system.
@@ -42,13 +42,14 @@ Repository File System
 - A journaling file system is strongly recommended. More information can be
 - A journaling file system is strongly recommended. More information can be
   found in :ref:`file-systems`.
   found in :ref:`file-systems`.
 - |project_name| requires the following file system operations:
 - |project_name| requires the following file system operations:
+
   - create, open, read, write, seek, close, rename, delete
   - create, open, read, write, seek, close, rename, delete
   - link - when upgrading an Attic repo in-place
   - link - when upgrading an Attic repo in-place
   - listdir, stat
   - listdir, stat
-  - posix_fadvise - to not flood the operating system's cache
-  - sync on files and directories to ensure data is written onto storage media
+  - fsync on files and directories to ensure data is written onto storage media
+    (some file systems do not support fsync on directories, which Borg accomodates for)
 
 
-:ref:`data-structures-and-file-formats` contains additional information about how |project_name|
+:ref:`data-structures` contains additional information about how |project_name|
 manages data.
 manages data.
 
 
 .. _locking: https://en.wikipedia.org/wiki/File_locking#Lock_files
 .. _locking: https://en.wikipedia.org/wiki/File_locking#Lock_files

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

@@ -1,6 +1,8 @@
 .. include:: ../global.rst.inc
 .. include:: ../global.rst.inc
 .. highlight:: none
 .. highlight:: none
 
 
+.. _data-structures:
+
 Data structures and file formats
 Data structures and file formats
 ================================
 ================================
 
 
@@ -40,6 +42,8 @@ called segments_. Each segment is a series of log entries. The segment number to
 entry relative to its segment start establishes an ordering of the log entries. This is the "definition" of
 entry relative to its segment start establishes an ordering of the log entries. This is the "definition" of
 time for the purposes of the log.
 time for the purposes of the log.
 
 
+.. _config-file:
+
 Config file
 Config file
 ~~~~~~~~~~~
 ~~~~~~~~~~~
 
 

+ 2 - 0
docs/usage_general.rst.inc

@@ -207,6 +207,8 @@ Please note:
 
 
 .. _INI: https://docs.python.org/3.4/library/logging.config.html#configuration-file-format
 .. _INI: https://docs.python.org/3.4/library/logging.config.html#configuration-file-format
 
 
+.. _file-systems:
+
 File systems
 File systems
 ~~~~~~~~~~~~
 ~~~~~~~~~~~~