Repository navigation
docs: add borg analyze usage examples with real output - #10526
Merged
ThomasWaldmann merged 1 commit intoOct 13, 2026
Merged
Conversation
Show --group-by name, a single series with hot spots, archive filters and --json processing with jq, using output from a real repository with three overlapping archive series. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
The
borg analyzeusage docs had no examples. This adds an Examples section todocs/usage/analyze.rst, with real output from a test repository with three archive series (home,projectsas an overlapping subdirectory of home, andetc) and one soft-deleted archive:borg analyze --group-by name: the per-series decomposition, and how to read it (exclusive vs. shared, unreferenced chunks), with a hint to use--group-by name,hostin multi-client repositories.borg analyze --match-archives home: deduplicated vs. exclusive size of one series, plus hot spots (a deleted download, a churning cache directory as an exclude candidate). It also notes that the hot spot analysis should be restricted to a single series, as comparing archives of different series reports most of their content as changed.--last 2) to analyze part of a series.--jsonprocessed withjq.🤖 Generated with Claude Code