Browse Source

manual fixes

sometimes the AI got it wrong.
also some other fixes.
Thomas Waldmann 4 days ago
parent
commit
3f9ad883cb

+ 1 - 1
README.rst

@@ -90,7 +90,7 @@ Main features
     * FreeBSD
     * FreeBSD
     * OpenBSD and NetBSD (no xattrs/ACLs support or binaries yet)
     * OpenBSD and NetBSD (no xattrs/ACLs support or binaries yet)
     * Cygwin (experimental, no binaries yet)
     * Cygwin (experimental, no binaries yet)
-    * Windows Subsystem for Linux (WSL) on Windows 10 (experimental)
+    * Windows Subsystem for Linux (WSL) on Windows 10/11 (experimental)
 
 
 **Free and Open Source Software**
 **Free and Open Source Software**
   * security and functionality can be audited independently
   * security and functionality can be audited independently

+ 1 - 1
docs/deployment/automated-local.rst

@@ -104,7 +104,7 @@ modify it to suit your needs (e.g. more backup sets, dumping databases etc.).
     # Create backups
     # Create backups
     #
     #
 
 
-    # Options for Borg create
+    # Options for borg create
     BORG_OPTS="--stats --one-file-system --compression lz4 --checkpoint-interval 86400"
     BORG_OPTS="--stats --one-file-system --compression lz4 --checkpoint-interval 86400"
 
 
     # Set BORG_PASSPHRASE or BORG_PASSCOMMAND somewhere around here, using export,
     # Set BORG_PASSPHRASE or BORG_PASSCOMMAND somewhere around here, using export,

+ 1 - 1
docs/deployment/pull-backup.rst

@@ -54,7 +54,7 @@ completely in every aspect from such a backup.
 
 
 .. warning::
 .. warning::
 
 
-    The chroot method was chosen to get the right user and group name-ID
+    The chroot method was chosen to get the right user and group name-id
     mappings, assuming they only come from files (/etc/passwd and group).
     mappings, assuming they only come from files (/etc/passwd and group).
     This assumption might be wrong, e.g. if users/groups also come from
     This assumption might be wrong, e.g. if users/groups also come from
     ldap or other providers.
     ldap or other providers.

+ 1 - 1
docs/quickstart.rst

@@ -49,7 +49,7 @@ by deleting/pruning archives. This mechanism is not bullet-proof in some
 circumstances [1]_.
 circumstances [1]_.
 
 
 If you *really* run out of disk space, it can be hard or impossible to free space,
 If you *really* run out of disk space, it can be hard or impossible to free space,
-because Borg needs free space to operate—even to delete backup
+because Borg needs free space to operate  even to delete backup
 archives.
 archives.
 
 
 You can use some monitoring process or just include the free space information
 You can use some monitoring process or just include the free space information

+ 1 - 1
docs/usage/notes.rst

@@ -320,7 +320,7 @@ repository. Make sure that backup client machines only get to access the reposit
 ``borg serve``.
 ``borg serve``.
 
 
 Ensure that no remote access is possible if the repository is temporarily set to normal mode
 Ensure that no remote access is possible if the repository is temporarily set to normal mode
-for example, regular pruning.
+(for example, for regular pruning).
 
 
 Further protections can be implemented, but are outside of Borg's scope. For example,
 Further protections can be implemented, but are outside of Borg's scope. For example,
 file system snapshots or wrapping ``borg serve`` to set special permissions or ACLs on
 file system snapshots or wrapping ``borg serve`` to set special permissions or ACLs on

+ 1 - 1
scripts/borg.exe.spec

@@ -51,7 +51,7 @@ exe = EXE(pyz,
           console=True)
           console=True)
 
 
 # Build a directory-based binary in addition to a packed
 # Build a directory-based binary in addition to a packed
-# single-file. This allows one to easily look at all included
+# single file. This allows one to easily look at all included
 # files (e.g., without having to strace or halt the built binary
 # files (e.g., without having to strace or halt the built binary
 # and introspect /tmp). Also avoids unpacking all libraries when
 # and introspect /tmp). Also avoids unpacking all libraries when
 # running the app, which is better for app signing on various operating systems.
 # running the app, which is better for app signing on various operating systems.

+ 4 - 4
src/borg/archiver.py

@@ -4507,13 +4507,13 @@ class Archiver:
         reduce problems with manual input. The ``--qr-html`` option creates a printable
         reduce problems with manual input. The ``--qr-html`` option creates a printable
         HTML template with a QR code and a copy of the ``--paper``-formatted key.
         HTML template with a QR code and a copy of the ``--paper``-formatted key.
 
 
-        For repositories using key file encryption the key is saved locally
+        For repositories using keyfile encryption the key is saved locally
         on the system that is capable of doing backups. To guard against loss
         on the system that is capable of doing backups. To guard against loss
         of this key, the key needs to be backed up independently of the main
         of this key, the key needs to be backed up independently of the main
         data backup.
         data backup.
 
 
         For repositories using repokey encryption, the key is saved in the
         For repositories using repokey encryption, the key is saved in the
-        repository's config file. A backup is thus not strictly needed,
+        repository in the config file. A backup is thus not strictly needed,
         but it guards against the repository becoming inaccessible if the file
         but it guards against the repository becoming inaccessible if the file
         is damaged for some reason.
         is damaged for some reason.
 
 
@@ -4551,7 +4551,7 @@ class Archiver:
         process in which each line is checked for plausibility before
         process in which each line is checked for plausibility before
         proceeding to the next line. For this format, PATH must not be provided.
         proceeding to the next line. For this format, PATH must not be provided.
 
 
-        For repositories using key file encryption, the key file which ``borg key
+        For repositories using keyfile encryption, the key file which ``borg key
         import`` writes to depends on several factors. If the ``BORG_KEY_FILE``
         import`` writes to depends on several factors. If the ``BORG_KEY_FILE``
         environment variable is set and non-empty, ``borg key import`` creates
         environment variable is set and non-empty, ``borg key import`` creates
         or overwrites the file named by ``$BORG_KEY_FILE``. Otherwise, ``borg
         or overwrites the file named by ``$BORG_KEY_FILE``. Otherwise, ``borg
@@ -5073,7 +5073,7 @@ class Archiver:
         the first backup after the conversion takes longer than expected
         the first backup after the conversion takes longer than expected
         due to the cache re-sync.
         due to the cache re-sync.
 
 
-        The upgrade should be able to resume if interrupted, although it
+        Upgrade should be able to resume if interrupted, although it
         will still iterate over all segments. If you want to start
         will still iterate over all segments. If you want to start
         from scratch, use ``borg delete`` over the copied repository to
         from scratch, use ``borg delete`` over the copied repository to
         make sure the cache files are also removed::
         make sure the cache files are also removed::

+ 1 - 1
src/borg/chunker.pyx

@@ -58,7 +58,7 @@ def dread(offset, size, fd=None, fh=-1):
         data = os.read(fh, size)
         data = os.read(fh, size)
         if hasattr(os, 'posix_fadvise'):
         if hasattr(os, 'posix_fadvise'):
             # UNIX-only and, in case of block sizes that are not a multiple of the
             # UNIX-only and, in case of block sizes that are not a multiple of the
-            # system's page size, it is better used with a bug-fixed Linux kernel >= 4.6.0,
+            # system's page size, it is better used with a bug-fixed Linux kernel > 4.6.0,
             # see comment/workaround in _chunker.c and borgbackup issue #907.
             # see comment/workaround in _chunker.c and borgbackup issue #907.
             os.posix_fadvise(fh, offset, len(data), os.POSIX_FADV_DONTNEED)
             os.posix_fadvise(fh, offset, len(data), os.POSIX_FADV_DONTNEED)
         return data
         return data

+ 1 - 1
src/borg/crypto/file_integrity.py

@@ -153,7 +153,7 @@ class IntegrityCheckedFile(FileLikeWrapper):
         # Hash the name of the file, but only the basename, i.e. not the path.
         # Hash the name of the file, but only the basename, i.e. not the path.
         # In Borg the name itself encodes the context (e.g., index.N, cache, files),
         # In Borg the name itself encodes the context (e.g., index.N, cache, files),
         # while the path doesn't matter, and moving e.g. a repository or cache directory is supported.
         # while the path doesn't matter, and moving e.g. a repository or cache directory is supported.
-        # Changing the name, however, implies a change of context that is not permissible.
+        # Changing the name, however, imbues a change of context that is not permissible.
         # While Borg does not use anything except ASCII in these file names, it's important to use
         # While Borg does not use anything except ASCII in these file names, it's important to use
         # the same encoding everywhere for portability. Using os.fsencode() would be wrong.
         # the same encoding everywhere for portability. Using os.fsencode() would be wrong.
         filename = os.path.basename(filename or self.path)
         filename = os.path.basename(filename or self.path)

+ 1 - 1
src/borg/crypto/key.py

@@ -47,7 +47,7 @@ class PasscommandFailure(Error):
 
 
 
 
 class PassphraseWrong(Error):
 class PassphraseWrong(Error):
-    """Passphrase supplied via BORG_PASSPHRASE, by BORG_PASSCOMMAND, or via BORG_PASSPHRASE_FD is incorrect."""
+    """Passphrase supplied in BORG_PASSPHRASE, by BORG_PASSCOMMAND, or via BORG_PASSPHRASE_FD is incorrect."""
     exit_mcode = 52
     exit_mcode = 52
 
 
 
 

+ 1 - 1
src/borg/fuse.py

@@ -59,7 +59,7 @@ def fuse_main():
 # size of some LRUCaches (1 element per simultaneously open file)
 # size of some LRUCaches (1 element per simultaneously open file)
 # note: _inode_cache might have rather large elements - Item.chunks can be large!
 # note: _inode_cache might have rather large elements - Item.chunks can be large!
 #       also, simultaneously reading too many files should be avoided anyway.
 #       also, simultaneously reading too many files should be avoided anyway.
-#       thus, do not set FILES to very high values.
+#       thus, do not set FILES to high values.
 FILES = 4
 FILES = 4
 
 
 
 

+ 1 - 1
src/borg/hashindex.pyx

@@ -70,7 +70,7 @@ to MAX_VALUE (inclusive). The following reserved values beyond MAX_VALUE are cur
     0xffffffff marks empty entries in the hash table
     0xffffffff marks empty entries in the hash table
     0xfffffffe marks deleted entries in the hash table
     0xfffffffe marks deleted entries in the hash table
 
 
-None of the publicly available classes in this module will neither accept nor return a reserved value;
+The publicly available classes in this module will neither accept nor return a reserved value;
 AssertionError is raised instead.
 AssertionError is raised instead.
 """
 """
 
 

+ 1 - 1
src/borg/logger.py

@@ -152,7 +152,7 @@ def create_logger(name=None):
     We use it to avoid errors and provide a more standard API.
     We use it to avoid errors and provide a more standard API.
 
 
     We must create the logger lazily because this is usually called from
     We must create the logger lazily because this is usually called from
-    module level (and thus executed at import time—before setup_logging()
+    module level (and thus executed at import time  before setup_logging()
     is called). By doing it lazily we can do the setup first; we just have to
     is called). By doing it lazily we can do the setup first; we just have to
     be careful not to call any logger methods before the setup_logging() call.
     be careful not to call any logger methods before the setup_logging() call.
     If you try, you'll get an exception.
     If you try, you'll get an exception.

+ 3 - 3
src/borg/platform/__init__.py

@@ -26,17 +26,17 @@ else:
     from .windows import process_alive, local_pid_alive
     from .windows import process_alive, local_pid_alive
     from .windows import uid2user, user2uid, gid2group, group2gid, getosusername
     from .windows import uid2user, user2uid, gid2group, group2gid, getosusername
 
 
-if is_linux:  # pragma: Linux only
+if is_linux:  # pragma: linux only
     from .linux import API_VERSION as OS_API_VERSION
     from .linux import API_VERSION as OS_API_VERSION
     from .linux import listxattr, getxattr, setxattr
     from .linux import listxattr, getxattr, setxattr
     from .linux import acl_get, acl_set
     from .linux import acl_get, acl_set
     from .linux import set_flags, get_flags
     from .linux import set_flags, get_flags
     from .linux import SyncFile
     from .linux import SyncFile
-elif is_freebsd:  # pragma: FreeBSD only
+elif is_freebsd:  # pragma: freebsd only
     from .freebsd import API_VERSION as OS_API_VERSION
     from .freebsd import API_VERSION as OS_API_VERSION
     from .freebsd import listxattr, getxattr, setxattr
     from .freebsd import listxattr, getxattr, setxattr
     from .freebsd import acl_get, acl_set
     from .freebsd import acl_get, acl_set
-elif is_darwin:  # pragma: Darwin only
+elif is_darwin:  # pragma: darwin only
     from .darwin import API_VERSION as OS_API_VERSION
     from .darwin import API_VERSION as OS_API_VERSION
     from .darwin import listxattr, getxattr, setxattr
     from .darwin import listxattr, getxattr, setxattr
     from .darwin import acl_get, acl_set
     from .darwin import acl_get, acl_set

+ 1 - 1
src/borg/testsuite/upgrader.py

@@ -17,7 +17,7 @@ ATTIC_TAR = os.path.join(os.path.dirname(__file__), 'attic.tar.gz')
 
 
 def untar(tarfname, path, what):
 def untar(tarfname, path, what):
     """
     """
-    Extract the <tarfname> tar archive to <path>, including all entries starting with <what>.
+    Extract the <tarfname> tar archive to <path>, only the entries starting with <what>.
 
 
     Return the path to <what>.
     Return the path to <what>.
     """
     """

+ 1 - 1
src/borg/testsuite/xattr.py

@@ -56,7 +56,7 @@ class XattrTestCase(BaseTestCase):
         tmp_fn = os.fsencode(self.tmpfile.name)
         tmp_fn = os.fsencode(self.tmpfile.name)
         # Make it work even with ext4, which imposes rather low limits.
         # Make it work even with ext4, which imposes rather low limits.
         buffer.resize(size=64, init=True)
         buffer.resize(size=64, init=True)
-        # xattr raw key list will be greater than 64
+        # xattr raw key list will be longer than 64
         keys = [b'user.attr%d' % i for i in range(20)]
         keys = [b'user.attr%d' % i for i in range(20)]
         for key in keys:
         for key in keys:
             setxattr(tmp_fn, key, b'x')
             setxattr(tmp_fn, key, b'x')

+ 1 - 1
src/borg/upgrader.py

@@ -27,7 +27,7 @@ class AtticRepositoryUpgrader(Repository):
 
 
         These are the files that need to be upgraded here, from most
         These are the files that need to be upgraded here, from most
         important to least important: segments, key files, and various
         important to least important: segments, key files, and various
-        caches—the latter being optional, as they will be rebuilt if
+        caches  the latter being optional, as they will be rebuilt if
         missing.
         missing.
 
 
         We nevertheless do the order in reverse, as we prefer to do
         We nevertheless do the order in reverse, as we prefer to do