Merge pull request #2453 from enkore/f/bla

docs fixes

docs/faq.rst

@@ -348,7 +348,7 @@ How can I backup huge file(s) over a unstable connection?
 This is not a problem any more, see previous FAQ item.
 
 How can I restore huge file(s) over an unstable connection?
-----------------------------------------------------------
+-----------------------------------------------------------
 
 If you can not manage to extract the whole big file in one go, you can extract
 all the part files (see above) and manually concatenate them together.
@@ -383,7 +383,7 @@ If you run into that, try this:
 .. _a_status_oddity:
 
 I am seeing 'A' (added) status for an unchanged file!?
------------------------------------------------------
+------------------------------------------------------
 
 The files cache is used to determine whether |project_name| already
 "knows" / has backed up a file and if so, to skip the file from

docs/installation.rst

@@ -27,7 +27,7 @@ Pre-Installation Considerations
 
 Repository File System
 ~~~~~~~~~~~~~~~~~~~~~~
-:ref:`data-structures-and-file-formats`
+
 - |project_name| stores data only 3 directory levels deep and uses short file and
   directory names.
 - |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
   found in :ref:`file-systems`.
 - |project_name| requires the following file system operations:
+
   - create, open, read, write, seek, close, rename, delete
   - link - when upgrading an Attic repo in-place
   - 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.
 
 .. _locking: https://en.wikipedia.org/wiki/File_locking#Lock_files

docs/internals/data-structures.rst

@@ -1,6 +1,8 @@
 .. include:: ../global.rst.inc
 .. highlight:: none
 
+.. _data-structures:
+
 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
 time for the purposes of the log.
 
+.. _config-file:
+
 Config file
 ~~~~~~~~~~~
 

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
 
+.. _file-systems:
+
 File systems
 ~~~~~~~~~~~~