Preserve the comments of the "cli.toml" on changes #2002
Merged
Conversation
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
bfops
reviewed
Nov 22, 2024
bfops
reviewed
Nov 22, 2024
mamcx
force-pushed
the
mamcx/config-preserve-edits
branch
from
82ba41f to
d69605d
Compare
bfops
reviewed
Dec 31, 2024
bfops
reviewed
Dec 31, 2024
bfops
reviewed
Dec 31, 2024
bfops
reviewed
Dec 31, 2024
bfops
reviewed
Dec 31, 2024
bfops
reviewed
Dec 31, 2024
bfops
approved these changes
Dec 31, 2024
Collaborator
bfops
left a comment
bfops
left a comment
There was a problem hiding this comment.
left lots of nits, none of them critical
gefjon
requested changes
Dec 31, 2024
Contributor
gefjon
left a comment
gefjon
left a comment
There was a problem hiding this comment.
Additional (manual) testing I would like to see done:
- Run multiple CLI processes concurrently / in parallel, such that they race to mutate a shared config file. Demonstrate that this does not corrupt or clear the config file, and describe the specific behavior.
- Manually create an ill-formed config file, run a CLI process that would mutate it, and demonstrate that the ill-formed file is not (further) corrupted or cleared. Describe the specific behavior.
Contributor
Author
I added an automated |
mamcx
force-pushed
the
mamcx/config-preserve-edits
branch
from
71d3830 to
82743f2
Compare
Co-authored-by: Phoebe Goldman <phoebe@clockworklabs.io> Signed-off-by: Mario Montoya <mamcx@elmalabarista.com>
mamcx
force-pushed
the
mamcx/config-preserve-edits
branch
from
82743f2 to
2b38e8a
Compare
bfops
approved these changes
Jan 3, 2025
Collaborator
bfops
left a comment
bfops
left a comment
There was a problem hiding this comment.
Thank you for addressing those comments!
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.
Description of Changes
We would like to preserve a user's manual edits, including comments, so now 'tolm_edit' is used for mutating the config file.
Closes #1798.
API and ABI breaking changes
Marked breaking because of the change of crate to parse and save. Is the low-level used by 'toml'.
Expected complexity level and risk
2:
Marked breaking because of the change of how to parse and save the file (that mutates instead of generating a fresh immutable view of the config) even if according to test there is none.
Testing