Merge branch 'master' into borg2

docs/deployment/central-backup-server.rst

@@ -95,7 +95,7 @@ The client needs to initialize the `pictures` repository like this:
 
  borg init backup@backup01.srv.local:pictures
 
-Or with the full path (should actually never be used, as only for demonstrational purposes).
+Or with the full path (should actually never be used, as only for demonstration purposes).
 The server should automatically change the current working directory to the `<client fqdn>` folder.
 
 ::

docs/installation.rst

@@ -355,6 +355,19 @@ activating your virtual environment::
 
     pip install -U borgbackup  # or ... borgbackup[llfuse/pyfuse3]
 
+When doing manual pip installation, man pages are not automatically
+installed.  You can run these commands to install the man pages
+locally::
+
+    # get borg from github
+    git clone https://github.com/borgbackup/borg.git borg
+
+    # Install the files with proper permissions
+    install -D -m 0644 borg/docs/man/borg*.1* $HOME/.local/share/man/man1/borg.1
+
+    # Update the man page cache
+    mandb
+
 .. _git-installation:
 
 Using git

docs/internals/frontends.rst

@@ -50,17 +50,20 @@ archive_progress
     The following keys exist, each represents the current progress.
 
     original_size
-        Original size of data processed so far (before compression and deduplication)
+        Original size of data processed so far (before compression and deduplication, may be empty/absent)
     compressed_size
-        Compressed size
+        Compressed size (may be empty/absent)
     deduplicated_size
-        Deduplicated size
+        Deduplicated size (may be empty/absent)
     nfiles
-        Number of (regular) files processed so far
+        Number of (regular) files processed so far (may be empty/absent)
     path
-        Current path
+        Current path (may be empty/absent)
     time
         Unix timestamp (float)
+    finished
+        boolean indicating whether the operation has finished, only the last object for an *operation*
+        can have this property set to *true*.
 
 progress_message
     A message-based progress information with no concrete progress information, just a message
@@ -450,7 +453,7 @@ Archive Differencing
 ++++++++++++++++++++
 
 Each archive difference item (file contents, user/group/mode) output by :ref:`borg_diff` is represented by an *ItemDiff* object.
-The propertiese of an *ItemDiff* object are:
+The properties of an *ItemDiff* object are:
 
 path:
     The filename/path of the *Item* (file, directory, symlink).

scripts/sdist-sign

@@ -17,4 +17,4 @@ python setup.py sdist
 
 D=dist/borgbackup-$R.tar.gz
 
-$GPG --detach-sign --local-user "Thomas Waldmann" --armor --output $D.asc $D
+$GPG --detach-sign --local-user "Thomas Waldmann" --armor --output "$D.asc" "$D"

scripts/sign-binaries

@@ -14,7 +14,7 @@ else
 fi
 
 for file in dist/borg-*; do
-    $GPG --local-user "Thomas Waldmann" --armor --detach-sign --output $file.asc $file
+    $GPG --local-user "Thomas Waldmann" --armor --detach-sign --output "$file.asc" "$file"
 done
 
-touch -t $D dist/*
+touch -t "$D" dist/*

scripts/upload-pypi

@@ -15,4 +15,4 @@ fi
 
 D=dist/borgbackup-$R.tar.gz
 
-twine upload $D.asc $D
+twine upload "$D.asc" "$D"

src/borg/archiver/help.py

@@ -177,7 +177,7 @@ class HelpMixIn:
         The first matching pattern is used, so if an include pattern matches
         before an exclude pattern, the file is backed up. Note that a no-recurse
         exclude stops examination of subdirectories so that potential includes
-        will not match - use normal exludes for such use cases.
+        will not match - use normal excludes for such use cases.
 
         **Tip: You can easily test your patterns with --dry-run and  --list**::