mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2025-03-10 06:03:38 +00:00
Code Issues Releases Wiki Activity

docs: installation: pre-install considerations, fix crossrefs

Browse source 
posix_fadvise -> only used when available; not part of the filesystem.
sync -> fsync
This commit is contained in:
Marian Beermann 2017-04-28 10:40:21 +02:00
parent e8b74fcac3
commit e036ebc340
3 changed files with 11 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/installation.rst
View file

@ -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 - fsync on files and directories to ensure data is written onto storage media
- sync 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
docs/internals/data-structures.rst
View file

@ -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
docs/usage_general.rst.inc
View file

@ -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
~~~~~~~~~~~~ ~~~~~~~~~~~~