Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions .github/workflows/canary.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Canary (Unlocked Requirements)

on:
schedule:
- cron: '0 9 * * 0' # Run weekly on Sunday at 09:00 UTC
- cron: '0 7 * * *' # Run at 07:00 UTC
workflow_dispatch: # Allow manual trigger

permissions:
Expand Down Expand Up @@ -47,6 +47,7 @@ jobs:

- name: Install Linux packages
if: ${{ runner.os == 'Linux' }}
shell: bash
run: |
sudo apt-get update
sudo apt-get install -y pkg-config build-essential
Expand All @@ -59,16 +60,19 @@ jobs:

- name: Install macOS packages
if: ${{ runner.os == 'macOS' }}
shell: bash
run: |
brew bundle install || true

- name: Install Python requirements (UNLOCKED)
shell: bash
run: |
python -m pip install --upgrade pip setuptools wheel
# Use UNLOCKED requirements to catch upstream breakages
pip install -r requirements.d/development.txt

- name: Install borgbackup
shell: bash
run: |
if [[ "${{ matrix.toxenv }}" == *"llfuse"* ]]; then
pip install -e ".[llfuse,cockpit]"
Expand All @@ -87,7 +91,7 @@ jobs:
python -m pytest -n4 --benchmark-skip -vv -rs -k "not remote" --cov=borg --cov-config=pyproject.toml --cov-report=xml --junitxml=test-results.xml
else
# Force tox to use the unlocked requirements in its environment creation
# by overriding the deps if possible, or just trusting it uses development.txt
# by overriding the deps if possible, or just trusting it uses development.txt
# which we already installed in the root. Actually tox creates its own venv.
# We need to tell tox to use the unlocked file.
tox -e ${{ matrix.toxenv }} --override "env_run_base.deps=[-rrequirements.d/development.txt]"
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ borg.exe
coverage.xml
test-results.xml
.vagrant

.DS_Store
5 changes: 3 additions & 2 deletions docs/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,8 @@ Compatibility notes:
Change Log 2.x
==============

Version 2.0.0b21 (not released yet)
-----------------------------------
Version 2.0.0b21 (2026-03-16)
-----------------------------

Please note:

Expand All @@ -168,6 +168,7 @@ above.

New features:

- support https/http (REST) repositories via borgstore, #9480
- use jsonargparse as CLI argument/option parser, also supporting YAML configs
for defaults and auto-generated environment variables to override defaults, #6551
- create --paths-from-shell-command, #5968
Expand Down
12 changes: 6 additions & 6 deletions docs/man/borg-analyze.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.4 manpage writer.
.
.
.nr rst2man-indent-level 0
Expand Down Expand Up @@ -27,8 +28,8 @@ 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-12-23" "" "borg backup tool"
.SH NAME
.TH "borg-analyze" "1" "2026-03-15" "" "borg backup tool"
.SH Name
borg-analyze \- Analyzes archives.
.SH SYNOPSIS
.sp
Expand Down Expand Up @@ -85,7 +86,6 @@ consider archives newer than (now \- TIMESPAN), e.g., 7d or 12m.
.SH SEE ALSO
.sp
\fIborg\-common(1)\fP
.SH AUTHOR
.SH Author
The Borg Collective
.\" Generated by docutils manpage writer.
.
.\" End of generated man page.
18 changes: 12 additions & 6 deletions docs/man/borg-benchmark-cpu.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.4 manpage writer.
.
.
.nr rst2man-indent-level 0
Expand Down Expand Up @@ -27,8 +28,8 @@ 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-12-23" "" "borg backup tool"
.SH NAME
.TH "borg-benchmark-cpu" "1" "2026-03-15" "" "borg backup tool"
.SH Name
borg-benchmark-cpu \- Benchmark CPU-bound operations.
.SH SYNOPSIS
.sp
Expand All @@ -48,10 +49,15 @@ enough free memory so there will be no slow down due to paging activity
.SH OPTIONS
.sp
See \fIborg\-common(1)\fP for common options of Borg commands.
.SS options
.INDENT 0.0
.TP
.B \-\-json
format output as JSON
.UNINDENT
.SH SEE ALSO
.sp
\fIborg\-common(1)\fP
.SH AUTHOR
.SH Author
The Borg Collective
.\" Generated by docutils manpage writer.
.
.\" End of generated man page.
18 changes: 12 additions & 6 deletions docs/man/borg-benchmark-crud.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.4 manpage writer.
.
.
.nr rst2man-indent-level 0
Expand Down Expand Up @@ -27,8 +28,8 @@ 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-12-23" "" "borg backup tool"
.SH NAME
.TH "borg-benchmark-crud" "1" "2026-03-15" "" "borg backup tool"
.SH Name
borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
.SH SYNOPSIS
.sp
Expand Down Expand Up @@ -89,10 +90,15 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
.B PATH
path where to create benchmark input data
.UNINDENT
.SS options
.INDENT 0.0
.TP
.B \-\-json\-lines
Format output as JSON Lines.
.UNINDENT
.SH SEE ALSO
.sp
\fIborg\-common(1)\fP
.SH AUTHOR
.SH Author
The Borg Collective
.\" Generated by docutils manpage writer.
.
.\" End of generated man page.
12 changes: 6 additions & 6 deletions docs/man/borg-benchmark.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.4 manpage writer.
.
.
.nr rst2man-indent-level 0
Expand Down Expand Up @@ -27,8 +28,8 @@ 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-12-23" "" "borg backup tool"
.SH NAME
.TH "borg-benchmark" "1" "2026-03-15" "" "borg backup tool"
.SH Name
borg-benchmark \- benchmark command
.SH SYNOPSIS
.nf
Expand All @@ -42,7 +43,6 @@ These commands do various benchmarks.
.SH SEE ALSO
.sp
\fIborg\-common(1)\fP, \fIborg\-benchmark\-crud(1)\fP, \fIborg\-benchmark\-cpu(1)\fP
.SH AUTHOR
.SH Author
The Borg Collective
.\" Generated by docutils manpage writer.
.
.\" End of generated man page.
12 changes: 6 additions & 6 deletions docs/man/borg-break-lock.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.4 manpage writer.
.
.
.nr rst2man-indent-level 0
Expand Down Expand Up @@ -27,8 +28,8 @@ 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-12-23" "" "borg backup tool"
.SH NAME
.TH "borg-break-lock" "1" "2026-03-15" "" "borg backup tool"
.SH Name
borg-break-lock \- Breaks the repository lock (for example, if it was left by a dead Borg process).
.SH SYNOPSIS
.sp
Expand All @@ -44,7 +45,6 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
.SH SEE ALSO
.sp
\fIborg\-common(1)\fP
.SH AUTHOR
.SH Author
The Borg Collective
.\" Generated by docutils manpage writer.
.
.\" End of generated man page.
16 changes: 8 additions & 8 deletions docs/man/borg-check.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.4 manpage writer.
.
.
.nr rst2man-indent-level 0
Expand Down Expand Up @@ -27,8 +28,8 @@ 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-12-23" "" "borg backup tool"
.SH NAME
.TH "borg-check" "1" "2026-03-15" "" "borg backup tool"
.SH Name
borg-check \- Checks repository consistency.
.SH SYNOPSIS
.sp
Expand All @@ -44,7 +45,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 an <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
Expand Down Expand Up @@ -105,7 +106,7 @@ 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
\fBNOTE:\fP
\fBNote:\fP
.INDENT 0.0
.INDENT 3.5
\fB\-\-repair\fP is a \fBPOTENTIALLY DANGEROUS FEATURE\fP and might lead to data
Expand Down Expand Up @@ -197,7 +198,6 @@ consider archives newer than (now \- TIMESPAN), e.g., 7d or 12m.
.SH SEE ALSO
.sp
\fIborg\-common(1)\fP
.SH AUTHOR
.SH Author
The Borg Collective
.\" Generated by docutils manpage writer.
.
.\" End of generated man page.
12 changes: 6 additions & 6 deletions docs/man/borg-common.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.4 manpage writer.
.
.
.nr rst2man-indent-level 0
Expand Down Expand Up @@ -27,8 +28,8 @@ 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-12-23" "" "borg backup tool"
.SH NAME
.TH "borg-common" "1" "2026-03-15" "" "borg backup tool"
.SH Name
borg-common \- Common options of Borg commands
.SH SYNOPSIS
.INDENT 0.0
Expand Down Expand Up @@ -99,7 +100,6 @@ repository to use
.SH SEE ALSO
.sp
\fIborg\-common(1)\fP
.SH AUTHOR
.SH Author
The Borg Collective
.\" Generated by docutils manpage writer.
.
.\" End of generated man page.
12 changes: 6 additions & 6 deletions docs/man/borg-compact.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.4 manpage writer.
.
.
.nr rst2man-indent-level 0
Expand Down Expand Up @@ -27,8 +28,8 @@ 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-COMPACT" "1" "2025-12-23" "" "borg backup tool"
.SH NAME
.TH "borg-compact" "1" "2026-03-15" "" "borg backup tool"
.SH Name
borg-compact \- Collects garbage in the repository.
.SH SYNOPSIS
.sp
Expand Down Expand Up @@ -103,7 +104,6 @@ $ borg compact
.SH SEE ALSO
.sp
\fIborg\-common(1)\fP
.SH AUTHOR
.SH Author
The Borg Collective
.\" Generated by docutils manpage writer.
.
.\" End of generated man page.
12 changes: 6 additions & 6 deletions docs/man/borg-completion.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.4 manpage writer.
.
.
.nr rst2man-indent-level 0
Expand Down Expand Up @@ -27,8 +28,8 @@ 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-COMPLETION" "1" "2025-12-23" "" "borg backup tool"
.SH NAME
.TH "borg-completion" "1" "2026-03-15" "" "borg backup tool"
.SH Name
borg-completion \- Output shell completion script for the given shell.
.SH SYNOPSIS
.sp
Expand Down Expand Up @@ -70,7 +71,6 @@ eval \(dq$(borg completion zsh)\(dq
.SH SEE ALSO
.sp
\fIborg\-common(1)\fP
.SH AUTHOR
.SH Author
The Borg Collective
.\" Generated by docutils manpage writer.
.
.\" End of generated man page.
14 changes: 7 additions & 7 deletions docs/man/borg-compression.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.\" Man page generated from reStructuredText.
.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.4 manpage writer.
.
.
.nr rst2man-indent-level 0
Expand Down Expand Up @@ -27,8 +28,8 @@ 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-COMPRESSION" "1" "2025-12-23" "" "borg backup tool"
.SH NAME
.TH "borg-compression" "1" "2026-03-15" "" "borg backup tool"
.SH Name
borg-compression \- Details regarding compression
.SH DESCRIPTION
.sp
Expand Down Expand Up @@ -152,7 +153,7 @@ Example probabilities for SPEC \fB1\fP:
.UNINDENT
.sp
Uses the Padmé algorithm to deterministically pad the compressed size to a sum of
powers of 2, limiting overhead to 12%. See <https://lbarman.ch/blog/padme/> for details.
powers of 2, limiting overhead to 12%. See \%<https://\:lbarman\:.ch/\:blog/\:padme/> for details.
.UNINDENT
.sp
Examples:
Expand All @@ -174,7 +175,6 @@ borg create \-\-compression obfuscate,250,zstd,3 ...
.EE
.UNINDENT
.UNINDENT
.SH AUTHOR
.SH Author
The Borg Collective
.\" Generated by docutils manpage writer.
.
.\" End of generated man page.
Loading
Loading