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

Move autosaved data to dedicated config file #499

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jwueller
Copy link

Autosaved data is instead saved to a *.autosave.cfg config file, which is automatically loaded along it's associated main *.cfg file.

The goal is to eventually no longer modify user-authored configuration automatically, so that it can't introduce unintended changes. This will also allow proper version control of config files without producing unnecessarily noisy diffs.

Autosaved data will keep being read from both embedded and dedicated sources, but the SAVE_CONFIG command will only write the dedicated file from now on. This maintains backwards-compatibility, while gradually migrating existing autosaved settings to the *.autosave.cfg file whenever the command keeps being used.

This is just the first step in a bigger migration process, and therefore still requires some automated changes to the user config files at the moment. However, this will reduce the necessary changes, and is only required while the embedded autosave system is still supported.

Checklist

  • pr title makes sense
  • squashed to 1 commit
  • added a test case if possible
  • if new feature, added to the readme
  • ci is happy and green

@jwueller
Copy link
Author

This might still need some mentions in the docs before it's ready for full review.

@jwueller jwueller force-pushed the feature/autosave-file branch 3 times, most recently from df2f2f4 to 989eacd Compare January 1, 2025 17:09
Autosaved data is instead saved to a *.autosave.cfg config file, which
is automatically loaded along it's associated main *.cfg file.

The goal is to eventually no longer modify user-authored configuration
automatically, so that it can't introduce unintended changes. This will
also allow proper version control of config files without producing
unnecessarily noisy diffs.

Autosaved data will keep being read from both embedded and dedicated
sources, but the SAVE_CONFIG command will only write the dedicated
file from now on. This maintains backwards-compatibility, while
gradually migrating existing autosaved settings to the *.autosave.cfg
file whenever the command keeps being used.

This is just the first step in a bigger migration process, and
therefore still requires some automated changes to the user config
files at the moment. However, this will reduce the necessary changes,
and is only required while the embedded autosave system is still
supported.
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