Browse Source

docs: add link to tempfile module

Linking tempfile docs helps to figure out, which default value might be
used, if TMPDIR is not set.
lumbric 7 years ago
parent
commit
bbd1533c99
1 changed files with 3 additions and 1 deletions
  1. 3 1
      docs/usage_general.rst.inc

+ 3 - 1
docs/usage_general.rst.inc

@@ -202,7 +202,7 @@ General:
         exceptions is not shown.
         exceptions is not shown.
         Please only use for good reasons as it makes issues harder to analyze.
         Please only use for good reasons as it makes issues harder to analyze.
     TMPDIR
     TMPDIR
-        where temporary files are stored (might need a lot of temporary space for some operations)
+        where temporary files are stored (might need a lot of temporary space for some operations), see tempfile_ for details
 
 
 Some automatic "answerers" (if set, they automatically answer confirmation questions):
 Some automatic "answerers" (if set, they automatically answer confirmation questions):
     BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK=no (or =yes)
     BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK=no (or =yes)
@@ -261,6 +261,8 @@ Please note:
 
 
 .. _INI: https://docs.python.org/3/library/logging.config.html#configuration-file-format
 .. _INI: https://docs.python.org/3/library/logging.config.html#configuration-file-format
 
 
+.. _tempfile: https://docs.python.org/3/library/tempfile.html#tempfile.gettempdir
+
 .. _file-systems:
 .. _file-systems:
 
 
 File systems
 File systems