Skip to content

docs: document platformdirs change and platform-specific directory paths, fixes #7332#9369

Merged
ThomasWaldmann merged 1 commit intoborgbackup:masterfrom
mr-raj12:docs-platformdirs-7332
Feb 27, 2026
Merged

docs: document platformdirs change and platform-specific directory paths, fixes #7332#9369
ThomasWaldmann merged 1 commit intoborgbackup:masterfrom
mr-raj12:docs-platformdirs-7332

Conversation

@mr-raj12
Copy link
Contributor

Description

Document the platformdirs change introduced in PR #7300 for borg 2, as requested in #7332.

  • Add platform-specific directory defaults table (Linux, macOS, Windows) to the environment variables docs
  • Expand the platformdirs upgrade note in changes.rst with full macOS/Windows paths
  • Add "Keyfile considerations when upgrading from borg 1.x" section to transfer docs, covering the key file location change on macOS/Windows and workarounds
  • Update FAQ section titles and body text to be platform-aware instead of hardcoding Linux paths
  • Fix hardcoded ~/.config/borg/keys references in repo-create, data-structures, and key docs

Fixes #7332

Checklist

  • PR is against master (or maintenance branch if only applicable there)
  • New code has tests and docs where appropriate
  • Tests pass (run tox or the relevant test subset)
  • Commit messages are clean and reference related issues

@mr-raj12 mr-raj12 changed the title docs: document platformdirs change and platform-specific directory pa… docs: document platformdirs change and platform-specific directory paths, fixes #7332 Feb 18, 2026
Copy link
Member

@ThomasWaldmann ThomasWaldmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some minor things

@mr-raj12 mr-raj12 force-pushed the docs-platformdirs-7332 branch from 2685a7b to 02f4475 Compare February 27, 2026 06:21
Copy link
Member

@ThomasWaldmann ThomasWaldmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ThomasWaldmann ThomasWaldmann merged commit eb82eeb into borgbackup:master Feb 27, 2026
@ThomasWaldmann
Copy link
Member

Thanks!

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.

write docs about platformdirs change (borg2)

2 participants