Browse Source

Update docs for BORG_USE_CHUNKS_ARCHIVE

William Bonnaventure 11 months ago
parent
commit
f3c1444a41
2 changed files with 5 additions and 12 deletions
  1. 2 12
      docs/faq.rst
  2. 3 0
      docs/usage/general/environment.rst.inc

+ 2 - 12
docs/faq.rst

@@ -840,18 +840,8 @@ will make the subsequent rebuilds faster (because it needs to transfer less data
 from the repository). While being faster, the cache needs quite some disk space,
 from the repository). While being faster, the cache needs quite some disk space,
 which might be unwanted.
 which might be unwanted.
 
 
-There is a temporary (but maybe long lived) hack to avoid using lots of disk
-space for chunks.archive.d (see :issue:`235` for details):
-
-::
-
-    # this assumes you are working with the same user as the backup.
-    cd ~/.cache/borg/$(borg config /path/to/repo id)
-    rm -rf chunks.archive.d ; touch chunks.archive.d
-
-This deletes all the cached archive chunk indexes and replaces the directory
-that kept them with a file, so borg won't be able to store anything "in" there
-in future.
+You can disable the cached archive chunk indexes by setting the environment
+variable ``BORG_USE_CHUNKS_ARCHIVE`` to ``no``.
 
 
 This has some pros and cons, though:
 This has some pros and cons, though:
 
 

+ 3 - 0
docs/usage/general/environment.rst.inc

@@ -63,6 +63,9 @@ General:
         When set to a numeric value, this determines the maximum "time to live" for the files cache
         When set to a numeric value, this determines the maximum "time to live" for the files cache
         entries (default: 20). The files cache is used to quickly determine whether a file is unchanged.
         entries (default: 20). The files cache is used to quickly determine whether a file is unchanged.
         The FAQ explains this more detailed in: :ref:`always_chunking`
         The FAQ explains this more detailed in: :ref:`always_chunking`
+    BORG_USE_CHUNKS_ARCHIVE
+        When set to no (default: yes), the ``chunks.archive.d`` folder will not be used. This reduces
+        disk space usage but slows down cache resyncs.
     BORG_SHOW_SYSINFO
     BORG_SHOW_SYSINFO
         When set to no (default: yes), system information (like OS, Python version, ...) in
         When set to no (default: yes), system information (like OS, Python version, ...) in
         exceptions is not shown.
         exceptions is not shown.