Merge pull request #8458 from ThomasWaldmann/doc-updates

Doc updates

LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2015-2023 The Borg Collective (see AUTHORS file)
+Copyright (C) 2015-2024 The Borg Collective (see AUTHORS file)
 Copyright (C) 2010-2014 Jonas Borgström <jonas@borgstrom.se>
 All rights reserved.
 

docs/binaries/00_README.txt

@@ -25,7 +25,9 @@ borg-macos1012      macOS (built on macOS Sierra 10.12 with latest macFUSE from
 borg-freebsd14      FreeBSD (built on FreeBSD 14)
 
 *.tgz               similar to above, but built as a directory with files,
-                    not as a single self-extracting binary.
+                    not as a single self-extracting binary. using the directory
+                    build is faster and doesn't need as much space in the temp
+                    directory as the one-file build.
 *.asc               GnuPG signatures for *
 
 
@@ -53,6 +55,8 @@ Installing
 ----------
 
 It is suggested that you rename or symlink the binary to just "borg".
+If you need "borgfs", just also symlink it to the same binary, it will
+detect internally under which name it was invoked.
 
 On UNIX-like platforms, /usr/local/bin/ or ~/bin/ is a nice place for it,
 but you can invoke it from every place by giving a full path to it.

docs/conf.py

@@ -42,7 +42,7 @@ master_doc = "index"
 
 # General information about the project.
 project = "Borg - Deduplicating Archiver"
-copyright = "2010-2014 Jonas Borgström, 2015-2022 The Borg Collective (see AUTHORS file)"
+copyright = "2010-2014 Jonas Borgström, 2015-2024 The Borg Collective (see AUTHORS file)"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

docs/usage/general/return-codes.rst.inc

@@ -18,3 +18,5 @@ Return code Meaning
 
 If you use ``--show-rc``, the return code is also logged at the indicated
 level as the last log entry.
+
+The modern exit codes (return codes, "rc") are documented there: :ref:`msgid`

src/borg/archiver/mount_cmds.py

@@ -54,14 +54,26 @@ class MountMixIn:
 
         mount_epilog = process_epilog(
             """
-        This command mounts an archive as a FUSE filesystem. This can be useful
-        for browsing an archive or restoring individual files. When restoring,
-        take into account that the current FUSE implementation does not support
-        special fs flags and ACLs.
+        This command mounts a repository or an archive as a FUSE filesystem.
+        This can be useful for browsing or restoring individual files.
+
+        When restoring, take into account that the current FUSE implementation does
+        not support special fs flags and ACLs.
+
+        When mounting a repository, the top directories will be named like the
+        archives and the directory structure below these will be loaded on-demand from
+        the repository when entering these directories, so expect some delay.
 
         Unless the ``--foreground`` option is given the command will run in the
         background until the filesystem is ``umounted``.
 
+        Performance tips:
+
+        - when doing a "whole repository" mount:
+          do not enter archive dirs if not needed, this avoids on-demand loading.
+        - only mount a specific archive, not the whole repository.
+        - only mount specific paths in a specific archive, not the complete archive.
+
         The command ``borgfs`` provides a wrapper for ``borg mount``. This can also be
         used in fstab entries:
         ``/path/to/repo /mnt/point fuse.borgfs defaults,noauto 0 0``