Merge pull request #9235 from ThomasWaldmann/rel200b20

Release 2.0.0b20

Author: ThomasWaldmann

.github/workflows/ci.yml

@@ -279,7 +279,7 @@ jobs:
     - name: Build Borg fat binaries (${{ matrix.binary }})
       if: ${{ matrix.binary && startsWith(github.ref, 'refs/tags/') }}
       run: |
-        pip install 'pyinstaller==6.14.2'
+        pip install -r requirements.d/pyinstaller.txt
         mkdir -p dist/binary
         # Ensure locally built binaries in ./dist/binary are found during tox tests
         echo "$GITHUB_WORKSPACE/dist/binary" >> "$GITHUB_PATH"
@@ -429,7 +429,7 @@ jobs:
                 tox -e py311-mfusepy
 
                 if [[ "${{ matrix.do_binaries }}" == "true" && "${{ startsWith(github.ref, 'refs/tags/') }}" == "true" ]]; then
-                  python -m pip install 'pyinstaller==6.14.2'
+                  python -m pip install -r requirements.d/pyinstaller.txt
                   mkdir -p dist/binary
                   pyinstaller --clean --distpath=dist/binary scripts/borg.exe.spec
                   pushd dist/binary
@@ -576,7 +576,7 @@ jobs:
           . env/bin/activate
           # python -m pip install --upgrade pip
           # pip install --upgrade setuptools build wheel
-          pip install pyinstaller==6.14.2
+          pip install -r requirements.d/pyinstaller.txt
 
       - name: Build
         run: |

Vagrantfile

@@ -206,7 +206,7 @@ def install_pyinstaller()
     . ~/.bash_profile
     cd /vagrant/borg
     . borg-env/bin/activate
-    pip install 'pyinstaller==6.14.2'
+    pip install -r requirements.d/pyinstaller.txt
   EOF
 end
 

docs/changes.rst

@@ -144,8 +144,8 @@ Compatibility notes:
 Change Log 2.x
 ==============
 
-Version 2.0.0b20 (not released yet)
------------------------------------
+Version 2.0.0b20 (2025-12-24)
+-----------------------------
 
 Please note:
 

docs/man/borg-analyze.1

@@ -27,60 +27,60 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "BORG-ANALYZE" "1" "2025-08-02" "" "borg backup tool"
+.TH "BORG-ANALYZE" "1" "2025-12-23" "" "borg backup tool"
 .SH NAME
-borg-analyze \- Analyze archives
+borg-analyze \- Analyzes archives.
 .SH SYNOPSIS
 .sp
 borg [common options] analyze [options]
 .SH DESCRIPTION
 .sp
 Analyze archives to find \(dqhot spots\(dq.
 .sp
-Borg analyze relies on the usual archive matching options to select the
+\fBborg analyze\fP relies on the usual archive matching options to select the
 archives that should be considered for analysis (e.g. \fB\-a series_name\fP).
-Then it iterates over all matching archives, over all contained files and
-collects information about chunks stored in all directories it encountered.
+Then it iterates over all matching archives, over all contained files, and
+collects information about chunks stored in all directories it encounters.
 .sp
-It considers chunk IDs and their plaintext sizes (we don\(aqt have the compressed
-size in the repository easily available) and adds up added/removed chunks\(aq
-sizes per direct parent directory and outputs a list of \(dqdirectory: size\(dq.
+It considers chunk IDs and their plaintext sizes (we do not have the compressed
+size in the repository easily available) and adds up the sizes of added and removed
+chunks per direct parent directory, and outputs a list of \(dqdirectory: size\(dq.
 .sp
-You can use that list to find directories with a lot of \(dqactivity\(dq \- maybe
-some of these are temporary or cache directories you did forget to exclude.
+You can use that list to find directories with a lot of \(dqactivity\(dq — maybe
+some of these are temporary or cache directories you forgot to exclude.
 .sp
-To not have these unwanted directories in your backups, you could carefully
-exclude these in \fBborg create\fP (for future backups) or use \fBborg recreate\fP
-to re\-create existing archives without these.
+To avoid including these unwanted directories in your backups, you can carefully
+exclude them in \fBborg create\fP (for future backups) or use \fBborg recreate\fP
+to recreate existing archives without them.
 .SH OPTIONS
 .sp
 See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS Archive filters
 .INDENT 0.0
 .TP
 .BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN
-only consider archives matching all patterns. see \(dqborg help match\-archives\(dq.
+only consider archives matching all patterns. See \(dqborg help match\-archives\(dq.
 .TP
 .BI \-\-sort\-by \ KEYS
 Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
 .TP
 .BI \-\-first \ N
-consider first N archives after other filters were applied
+consider the first N archives after other filters are applied
 .TP
 .BI \-\-last \ N
-consider last N archives after other filters were applied
+consider the last N archives after other filters are applied
 .TP
 .BI \-\-oldest \ TIMESPAN
-consider archives between the oldest archive\(aqs timestamp and (oldest + TIMESPAN), e.g. 7d or 12m.
+consider archives between the oldest archive\(aqs timestamp and (oldest + TIMESPAN), e.g., 7d or 12m.
 .TP
 .BI \-\-newest \ TIMESPAN
-consider archives between the newest archive\(aqs timestamp and (newest \- TIMESPAN), e.g. 7d or 12m.
+consider archives between the newest archive\(aqs timestamp and (newest \- TIMESPAN), e.g., 7d or 12m.
 .TP
 .BI \-\-older \ TIMESPAN
-consider archives older than (now \- TIMESPAN), e.g. 7d or 12m.
+consider archives older than (now \- TIMESPAN), e.g., 7d or 12m.
 .TP
 .BI \-\-newer \ TIMESPAN
-consider archives newer than (now \- TIMESPAN), e.g. 7d or 12m.
+consider archives newer than (now \- TIMESPAN), e.g., 7d or 12m.
 .UNINDENT
 .SH SEE ALSO
 .sp

docs/man/borg-benchmark-cpu.1

@@ -27,15 +27,15 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "BORG-BENCHMARK-CPU" "1" "2025-08-02" "" "borg backup tool"
+.TH "BORG-BENCHMARK-CPU" "1" "2025-12-23" "" "borg backup tool"
 .SH NAME
-borg-benchmark-cpu \- Benchmark CPU bound operations.
+borg-benchmark-cpu \- Benchmark CPU-bound operations.
 .SH SYNOPSIS
 .sp
 borg [common options] benchmark cpu [options]
 .SH DESCRIPTION
 .sp
-This command benchmarks misc. CPU bound borg operations.
+This command benchmarks miscellaneous CPU\-bound Borg operations.
 .sp
 It creates input data in memory, runs the operation and then displays throughput.
 To reduce outside influence on the timings, please make sure to run this with:

docs/man/borg-benchmark-crud.1

@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "BORG-BENCHMARK-CRUD" "1" "2025-08-02" "" "borg backup tool"
+.TH "BORG-BENCHMARK-CRUD" "1" "2025-12-23" "" "borg backup tool"
 .SH NAME
 borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
 .SH SYNOPSIS
@@ -37,11 +37,11 @@ borg [common options] benchmark crud [options] PATH
 .sp
 This command benchmarks borg CRUD (create, read, update, delete) operations.
 .sp
-It creates input data below the given PATH and backups this data into the given REPO.
+It creates input data below the given PATH and backs up this data into the given REPO.
 The REPO must already exist (it could be a fresh empty repo or an existing repo, the
 command will create / read / update / delete some archives named borg\-benchmark\-crud* there.
 .sp
-Make sure you have free space there, you\(aqll need about 1GB each (+ overhead).
+Make sure you have free space there; you will need about 1 GB each (+ overhead).
 .sp
 If your repository is encrypted and borg needs a passphrase to unlock the key, use:
 .INDENT 0.0
@@ -87,7 +87,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
 .INDENT 0.0
 .TP
 .B PATH
-path were to create benchmark input data
+path where to create benchmark input data
 .UNINDENT
 .SH SEE ALSO
 .sp

docs/man/borg-benchmark.1

@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "BORG-BENCHMARK" "1" "2025-08-02" "" "borg backup tool"
+.TH "BORG-BENCHMARK" "1" "2025-12-23" "" "borg backup tool"
 .SH NAME
 borg-benchmark \- benchmark command
 .SH SYNOPSIS

docs/man/borg-break-lock.1

@@ -27,17 +27,17 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "BORG-BREAK-LOCK" "1" "2025-08-02" "" "borg backup tool"
+.TH "BORG-BREAK-LOCK" "1" "2025-12-23" "" "borg backup tool"
 .SH NAME
-borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg.
+borg-break-lock \- Breaks the repository lock (for example, if it was left by a dead Borg process).
 .SH SYNOPSIS
 .sp
 borg [common options] break\-lock [options]
 .SH DESCRIPTION
 .sp
 This command breaks the repository and cache locks.
-Please use carefully and only while no borg process (on any machine) is
-trying to access the Cache or the Repository.
+Use with care and only when no Borg process (on any machine) is
+trying to access the cache or the repository.
 .SH OPTIONS
 .sp
 See \fIborg\-common(1)\fP for common options of Borg commands.

docs/man/borg-check.1

@@ -27,9 +27,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "BORG-CHECK" "1" "2025-08-02" "" "borg backup tool"
+.TH "BORG-CHECK" "1" "2025-12-23" "" "borg backup tool"
 .SH NAME
-borg-check \- Check repository consistency
+borg-check \- Checks repository consistency.
 .SH SYNOPSIS
 .sp
 borg [common options] check [options]
@@ -44,7 +44,7 @@ the file magic headers, and both the metadata and data of all objects in
 the repository. The read data is checked by size and hash. Bit rot and other
 types of accidental damage can be detected this way. Running the repository
 check can be split into multiple partial checks using \fB\-\-max\-duration\fP\&.
-When checking a  <ssh://>  remote repository, please note that the checks run on
+When checking an  <ssh://>  remote repository, please note that the checks run on
 the server and do not cause significant network traffic.
 .IP 2. 3
 Checking consistency and correctness of the archive metadata and optionally
@@ -53,9 +53,9 @@ repository manifest exists, the archive metadata chunk is present, and that
 all chunks referencing files (items) in the archive exist. This requires
 reading archive and file metadata, but not data. To scan for archives whose
 entries were lost from the archive directory, pass \fB\-\-find\-lost\-archives\fP\&.
-It requires reading all data and is hence very time consuming.
+It requires reading all data and is hence very time\-consuming.
 To additionally cryptographically verify the file (content) data integrity,
-pass \fB\-\-verify\-data\fP, which is even more time consuming.
+pass \fB\-\-verify\-data\fP, which is even more time\-consuming.
 .sp
 When checking archives of a remote repository, archive checks run on the client
 machine because they require decrypting data and therefore the encryption key.
@@ -66,7 +66,7 @@ repository checks only, or pass \fB\-\-archives\-only\fP to run the archive chec
 only.
 .sp
 The \fB\-\-max\-duration\fP option can be used to split a long\-running repository
-check into multiple partial checks. After the given number of seconds the check
+check into multiple partial checks. After the given number of seconds, the check
 is interrupted. The next partial check will continue where the previous one
 stopped, until the full repository has been checked. Assuming a complete check
 would take 7 hours, then running a daily check with \fB\-\-max\-duration=3600\fP
@@ -77,31 +77,31 @@ archive checks, nor enable repair mode. Consequently, if you want to use
 \fB\-\-max\-duration\fP you must also pass \fB\-\-repository\-only\fP, and must not pass
 \fB\-\-archives\-only\fP, nor \fB\-\-repair\fP\&.
 .sp
-\fBWarning:\fP Please note that partial repository checks (i.e. running it with
+\fBWarning:\fP Please note that partial repository checks (i.e., running with
 \fB\-\-max\-duration\fP) can only perform non\-cryptographic checksum checks on the
-repository files. Enabling partial repository checks excepts archive checks
-for the same reason. Therefore partial checks may be useful with very large
-repositories only where a full check would take too long.
+repository files. Enabling partial repository checks excludes archive checks
+for the same reason. Therefore, partial checks may be useful only with very large
+repositories where a full check would take too long.
 .sp
 The \fB\-\-verify\-data\fP option will perform a full integrity verification (as
 opposed to checking just the xxh64) of data, which means reading the
 data from the repository, decrypting and decompressing it. It is a complete
-cryptographic verification and hence very time consuming, but will detect any
+cryptographic verification and hence very time\-consuming, but will detect any
 accidental and malicious corruption. Tamper\-resistance is only guaranteed for
-encrypted repositories against attackers without access to the keys. You can
-not use \fB\-\-verify\-data\fP with \fB\-\-repository\-only\fP\&.
+encrypted repositories against attackers without access to the keys. You cannot
+use \fB\-\-verify\-data\fP with \fB\-\-repository\-only\fP\&.
 .sp
 The \fB\-\-find\-lost\-archives\fP option will also scan the whole repository, but
 tells Borg to search for lost archive metadata. If Borg encounters any archive
-metadata that doesn\(aqt match with an archive directory entry (including
+metadata that does not match an archive directory entry (including
 soft\-deleted archives), it means that an entry was lost.
 Unless \fBborg compact\fP is called, these archives can be fully restored with
 \fB\-\-repair\fP\&. Please note that \fB\-\-find\-lost\-archives\fP must read a lot of
-data from the repository and is thus very time consuming. You can not use
+data from the repository and is thus very time\-consuming. You cannot use
 \fB\-\-find\-lost\-archives\fP with \fB\-\-repository\-only\fP\&.
 .SS About repair mode
 .sp
-The check command is a readonly task by default. If any corruption is found,
+The check command is a read\-only task by default. If any corruption is found,
 Borg will report the issue and proceed with checking. To actually repair the
 issues found, pass \fB\-\-repair\fP\&.
 .sp
@@ -124,7 +124,7 @@ It is highly recommended to create a backup of your repository before running
 in repair mode (i.e. running it with \fB\-\-repair\fP).
 .sp
 Repair mode will attempt to fix any corruptions found. Fixing corruptions does
-not mean recovering lost data: Borg can not magically restore data lost due to
+not mean recovering lost data: Borg cannot magically restore data lost due to
 e.g. a hardware failure. Repairing a repository means sacrificing some data
 for the sake of the repository as a whole and the remaining data. Hence it is,
 by definition, a potentially lossy task.
@@ -153,7 +153,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
 only perform repository checks
 .TP
 .B  \-\-archives\-only
-only perform archives checks
+only perform archive checks
 .TP
 .B  \-\-verify\-data
 perform cryptographic archive data integrity verification (conflicts with \fB\-\-repository\-only\fP)
@@ -165,34 +165,34 @@ attempt to repair any inconsistencies found
 attempt to find lost archives
 .TP
 .BI \-\-max\-duration \ SECONDS
-do only a partial repo check for max. SECONDS seconds (Default: unlimited)
+perform only a partial repository check for at most SECONDS seconds (default: unlimited)
 .UNINDENT
 .SS Archive filters
 .INDENT 0.0
 .TP
 .BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN
-only consider archives matching all patterns. see \(dqborg help match\-archives\(dq.
+only consider archives matching all patterns. See \(dqborg help match\-archives\(dq.
 .TP
 .BI \-\-sort\-by \ KEYS
 Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
 .TP
 .BI \-\-first \ N
-consider first N archives after other filters were applied
+consider the first N archives after other filters are applied
 .TP
 .BI \-\-last \ N
-consider last N archives after other filters were applied
+consider the last N archives after other filters are applied
 .TP
 .BI \-\-oldest \ TIMESPAN
-consider archives between the oldest archive\(aqs timestamp and (oldest + TIMESPAN), e.g. 7d or 12m.
+consider archives between the oldest archive\(aqs timestamp and (oldest + TIMESPAN), e.g., 7d or 12m.
 .TP
 .BI \-\-newest \ TIMESPAN
-consider archives between the newest archive\(aqs timestamp and (newest \- TIMESPAN), e.g. 7d or 12m.
+consider archives between the newest archive\(aqs timestamp and (newest \- TIMESPAN), e.g., 7d or 12m.
 .TP
 .BI \-\-older \ TIMESPAN
-consider archives older than (now \- TIMESPAN), e.g. 7d or 12m.
+consider archives older than (now \- TIMESPAN), e.g., 7d or 12m.
 .TP
 .BI \-\-newer \ TIMESPAN
-consider archives newer than (now \- TIMESPAN), e.g. 7d or 12m.
+consider archives newer than (now \- TIMESPAN), e.g., 7d or 12m.
 .UNINDENT
 .SH SEE ALSO
 .sp

docs/man/borg-common.1

@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "BORG-COMMON" "1" "2025-08-02" "" "borg backup tool"
+.TH "BORG-COMMON" "1" "2025-12-23" "" "borg backup tool"
 .SH NAME
 borg-common \- Common options of Borg commands
 .SH SYNOPSIS