Adhere to XDG's configuration specification #1320
Merged
Conversation
This file contains 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
K3d places default configuration values in the 'types' pkg, including the configuration directory. However, that value wasn't being used. This commit replaces the hardcoded ".k3d" string on the 'GetConfigDirOrCreate' function by the default value in the constant 'DefaultConfigDirName'. Signed-off-by: Carlos Torres <torr.ca@mailgw.com>
So far K3d has been creating the '.k3d' directory on the user's 'HOME' directory, which isn't the ideal place for configuration and violates the XDG base directory specification. This commit aligns the configuration persistency with the XDG spec, making the 'GetConfigDirOrCreate' function obtain the config dir from the 'XDG_CONFIG_HOME' environment variable, falling back to the '~/.config/k3d' default path in case the former is not set. Signed-off-by: Carlos Torres <torr.ca@mailgw.com>
iwilltry42
approved these changes
Aug 3, 2023
|
I wonder if we should do an automatic migration of files on first run 🤔 |
|
Thank you very much @torrca ! |
tesla59
pushed a commit
to tesla59/k3d
that referenced
this pull request
Aug 10, 2023
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.
What
This patch set makes 3 changes:
DefaultConfigDirNameconstant is used when creating the config directory;DefaultConfigDirNameconstant to the XDG default path for configuration;GetConfigDirOrCreatecheck the environment variableXDG_CONFIG_HOMEbefore using the default value;Why
Standardization, organization and customization.
Implications
This change makes the program more predictable, as most Unix tooling already uses the paths from the specification. Furthermore, it makes it more customizable, since the configuration path can be changed through a mere env var.