From 84940e32b20761aa7e07b006b55b92681bc472dc Mon Sep 17 00:00:00 2001 From: Thomas Kluyver Date: Sat, 15 Jul 2017 15:02:41 +0200 Subject: [PATCH 1/2] Use code markup for command line options Closes gh-2815 --- docs/usage/notes.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/usage/notes.rst b/docs/usage/notes.rst index 758649f5c..b2a818d26 100644 --- a/docs/usage/notes.rst +++ b/docs/usage/notes.rst @@ -5,8 +5,8 @@ Here are misc. notes about topics that are maybe not covered in enough detail in .. _chunker-params: ---chunker-params -~~~~~~~~~~~~~~~~ +``--chunker-params`` +~~~~~~~~~~~~~~~~~~~~ The chunker params influence how input files are cut into pieces (chunks) which are then considered for deduplication. They also have a big impact on @@ -50,8 +50,8 @@ a new repository when changing chunker params. For more details, see :ref:`chunker_details`. ---umask -~~~~~~~ +``--umask`` +~~~~~~~~~~~ If you use ``--umask``, make sure that all repository-modifying borg commands (create, delete, prune) that access the repository in question use the same @@ -60,8 +60,8 @@ If you use ``--umask``, make sure that all repository-modifying borg commands If multiple machines access the same repository, this should hold true for all of them. ---read-special -~~~~~~~~~~~~~~ +``--read-special`` +~~~~~~~~~~~~~~~~~~ The ``--read-special`` option is special - you do not want to use it for normal full-filesystem backups, but rather after carefully picking some targets for it. From 0fcdb97f5dd9b6fff125df926bdb5c11e75b9f33 Mon Sep 17 00:00:00 2001 From: Thomas Kluyver Date: Sat, 15 Jul 2017 15:03:46 +0200 Subject: [PATCH 2/2] Fix cross reference --- docs/usage/notes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/usage/notes.rst b/docs/usage/notes.rst index b2a818d26..85648382e 100644 --- a/docs/usage/notes.rst +++ b/docs/usage/notes.rst @@ -12,7 +12,7 @@ The chunker params influence how input files are cut into pieces (chunks) which are then considered for deduplication. They also have a big impact on resource usage (RAM and disk space) as the amount of resources needed is (also) determined by the total amount of chunks in the repository (see -`Indexes / Caches memory usage` for details). +:ref:`cache-memory-usage` for details). ``--chunker-params=10,23,16,4095`` results in a fine-grained deduplication| and creates a big amount of chunks and thus uses a lot of resources to manage