docs: document that borg transfer is incremental - #10212
Merged
ThomasWaldmann merged 1 commit intoAug 25, 2026
Merged
Conversation
Add an "Incremental transfer" section to the transfer command help: transfer skips archives that are already present in the destination repo (name+timestamp or name+id) and only stores chunks the destination does not have yet, so it can be run repeatedly (e.g. from a cron job). Also mention that interrupting a transfer is safe, that transfer never deletes anything in the destination repo, and add a pointer from the related FAQ entry. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #10212 +/- ##
=======================================
Coverage 87.25% 87.25%
=======================================
Files 102 102
Lines 18440 18440
Branches 2834 2834
=======================================
Hits 16090 16090
Misses 1643 1643
Partials 707 707 ☔ View full report in Codecov by Harness. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #9878.
borg transferalready is incremental, but nothing in the docs said so, so usershave to guess whether re-running it (e.g. from a cron job) is safe and cheap.
This adds an "Incremental transfer" section to the
borg transfercommand help(and thus to
docs/usage/transfer.rst.inc) covering:(checked by name+timestamp and by name+id), printing
archive is already present in destination repo, skipping.the destination are read from the source and stored.
-a-filters pattern from the issue.after it was copied completely, and the chunks stored so far are reused on the
next run - unless
borg compactruns on the destination in between.Also adds a pointer from the related FAQ entry ("Can I copy or synchronize my
repo to another location?") to
borg transfer.docs/usage/transfer.rst.incwas regenerated withscripts/make.py build_usage(only that one file changed); man pages were not regenerated, that is done at
release time.
🤖 Generated with Claude Code