mirror of
https://github.com/borgbackup/borg.git
synced 2025-03-09 21:57:24 +00:00
docs: installation: pre-install considerations, fix crossrefs
posix_fadvise -> only used when available; not part of the filesystem. sync -> fsync
This commit is contained in:
parent
e8b74fcac3
commit
e036ebc340
3 changed files with 11 additions and 4 deletions
|
@ -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
|
||||
|
|
|
@ -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
|
||||
~~~~~~~~~~~
|
||||
|
||||
|
|
|
@ -207,6 +207,8 @@ Please note:
|
|||
|
||||
.. _INI: https://docs.python.org/3.4/library/logging.config.html#configuration-file-format
|
||||
|
||||
.. _file-systems:
|
||||
|
||||
File systems
|
||||
~~~~~~~~~~~~
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue