Repository navigation
docs: use content-describing archive names, not the hostname - #10527
Merged
ThomasWaldmann merged 1 commit intoOct 13, 2026
Merged
Conversation
borg 2 stores hostname, username and time in the archive metadata and
uses the archive name as the series name (files cache, prune grouping),
so the archive name should describe the archive content and be stable.
- quickstart: automated backup script uses the "backup-sys-home" series
instead of '{hostname}', explain prune's default name+host grouping.
- help placeholders: replace the borg 1.x style {hostname}-{now} archive
name examples with -a host: and repo URL placeholder usage, explain
why archive names should not vary.
- create usage: remove the '{fqdn}-root' archive name example.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
ThomasWaldmann
force-pushed
the
quickstart-archive-name
branch
from
October 13, 2026 16:29
7b26b12 to
3c95ce7
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #10527 +/- ##
==========================================
- Coverage 89.34% 89.32% -0.02%
==========================================
Files 104 104
Lines 20079 20079
Branches 3152 3152
==========================================
- Hits 17940 17936 -4
- Misses 1481 1484 +3
- Partials 658 659 +1 ☔ 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
1 participant
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.
The quickstart and some help/usage examples still showed borg 1.x style archive names like
'{hostname}'or{hostname}-{user}-{utcnow}.In borg 2, hostname, username and time are stored in the archive metadata, and the archive name is the series name (used for the files cache and prune grouping). So the archive name should describe the archive content and stay the same for all archives of a series.
backup-sys-homeseries instead of'{hostname}'. The prune comment now explains that prune applies retention per archive name and host by default.borg help placeholders: replaced the{hostname}-{now}style examples withprune -a 'host:{hostname}'and a repo URL placeholder, and added a paragraph explaining why archive names should not vary.'{fqdn}-root'archive name example.Generated usage docs (
docs/usage/help.rst.inc) are not regenerated here; that happens at release time.🤖 Generated with Claude Code