Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adhere to XDG spec for file locations #385

Merged
merged 1 commit into from
Sep 17, 2024
Merged

Adhere to XDG spec for file locations #385

merged 1 commit into from
Sep 17, 2024

Conversation

LucasPickering
Copy link
Owner

@LucasPickering LucasPickering commented Sep 17, 2024

Description

Describe the change. If there is an associated issue, please include the issue link (e.g. "Closes #xxx"). For UI changes, please also include screenshots.

Use different directories for different purposes:

  • dirs::config_dir for config file, with a check to use the old dirs::data_dir if present for backward compatibility
  • dirs::data_dir for DB (same as current location)
  • dirs::state_dir for logs, falling back to data::cache_dir on MacOS/Windows

Closes #371

Known Risks

What issues could potentially go wrong with this change? Is it a breaking change? What have you done to mitigate any potential risks?

  • Could be a breaking change. Mitigated with a backward compatibility check
  • Added complexity. Mitigated with docs

QA

How did you test this?

Manually.

Checklist

  • Have you read CONTRIBUTING.md already?
  • Did you update CHANGELOG.md?
    • Only user-facing changes belong in the changelog. Internal changes such as refactors should only be included if they'll impact users, e.g. via performance improvement.
  • Did you remove all TODOs?
    • If there are unresolved issues, please open a follow-on issue and link to it in a comment so future work can be tracked

@LucasPickering LucasPickering enabled auto-merge (rebase) September 17, 2024 02:28
@LucasPickering LucasPickering merged commit 1d9387b into master Sep 17, 2024
15 checks passed
@LucasPickering LucasPickering deleted the xdg-dirs branch September 17, 2024 02:32
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.

Follow XDG Base Directory Specification for Linux
1 participant