Skip to content

docs: add borg analyze usage examples with real output - #10526

Merged
ThomasWaldmann merged 1 commit into
borgbackup:masterfrom
ThomasWaldmann:analyze-examples
Oct 13, 2026
Merged

ThomasWaldmann merged 1 commit into
borgbackup:masterfrom
ThomasWaldmann:analyze-examples

Conversation

@ThomasWaldmann

Copy link
Copy Markdown
Member

The borg analyze usage docs had no examples. This adds an Examples section to docs/usage/analyze.rst, with real output from a test repository with three archive series (home, projects as an overlapping subdirectory of home, and etc) 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,host in 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.
  • Archive filters (--last 2) to analyze part of a series.
  • --json processed with jq.

🤖 Generated with Claude Code

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>
@ThomasWaldmann
ThomasWaldmann merged commit 99f7fcb into borgbackup:master Oct 13, 2026
1 check passed
@ThomasWaldmann
ThomasWaldmann deleted the analyze-examples branch October 13, 2026 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant