docs: add docs for "key add", "key list" and "key remove"#9769
Merged
ThomasWaldmann merged 1 commit intoJun 13, 2026
Conversation
The multi-key feature (borgbackup#9743) added the "borg key add", "borg key list" and "borg key remove" subcommands but never wired up their docs: - scripts/make.py: map key_add/key_list/key_remove to the "key" usage group, so build_man can locate their examples (it previously aborted with FileNotFoundError: docs/usage/key_add.rst). - docs/usage/key.rst: include the three new generated snippets so they show up on the HTML key page. - regenerate the affected docs: new key_{add,list,remove}.rst.inc usage snippets, new borg-key-{add,list,remove}.1 man pages, and borg-key.1 (SYNOPSIS + SEE ALSO now reference the new subcommands). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #9769 +/- ##
=======================================
Coverage 84.85% 84.85%
=======================================
Files 92 92
Lines 15172 15172
Branches 2273 2273
=======================================
Hits 12874 12874
Misses 1593 1593
Partials 705 705 ☔ 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 multi-key feature (#9743) added the
borg key add,borg key listandborg key removesubcommands but never wired up their documentation.Changes
key_add/key_list/key_removeto thekeyusage group, sobuild_mancan locate their examples. Previouslybuild_manaborted withFileNotFoundError: docs/usage/key_add.rst.key_{add,list,remove}.rst.incusage snippetsborg-key-{add,list,remove}.1man pagesborg-key.1(SYNOPSIS + SEE ALSO now reference the new subcommands)Docs-only; no code changes.
🤖 Generated with Claude Code