storage.conf: Various cleanups #2066
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
The default storage.conf we ship is inconsistent in a few ways; there's a lot of fixes rolled up into this single commit. First: we were using a toml "inline table" for the pull options, and then documenting each key in that table in one blob above. It simply looks much nicer to use a non-inline table - then we can move the docs next to each individual value. This is also more consistent with other sections of the config. I also thinned out a bit the doc comments; I think instead of trying to have a longer explanation of zstd:chunked in the comments here we should refer to the man page, which is a better place to have details (and that we should fill out more). Per another PR, I also stumbled across the fact that we have a lot of "string bool" values and cannot be native TOML booleans. Document that clearly next to each type. We already have default values in the *code* for all of these, so comment them all out to be consistent with other values. (We're then getting closer to having the config file be entirely comments, but that's a distinct project) Finally, update the recent man pages I added to match these changes. Signed-off-by: Colin Walters <[email protected]>
|
Can we support both native and string at the same time? LGTM |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: cgwalters, flouthoc The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
I agree that maybe both |
Yes, I believe so, but we should look at that after this. |
|
Agreed. |
lsm5
added a commit
to lsm5/common
that referenced
this pull request
Sep 3, 2024
pull_options syntax has chagned recently. Ref: containers/storage#2066 Signed-off-by: Lokesh Mandvekar <[email protected]>
lsm5
added a commit
to lsm5/common
that referenced
this pull request
Sep 5, 2024
storage.conf has been updated upstream so the config files update script needs to account for that. Ref: containers/storage#2066 Signed-off-by: Lokesh Mandvekar <[email protected]>
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.
The default storage.conf we ship is inconsistent in a few ways; there's a lot of fixes rolled up into this single commit.
First: we were using a toml "inline table" for the pull options, and then documenting each key in that table in one blob above. It simply looks much nicer to use a non-inline table - then we can move the docs next to each individual value. This is also more consistent with other sections of the config.
I also thinned out a bit the doc comments; I think instead of trying to have a longer explanation of zstd:chunked in the comments here we should refer to the man page, which is a better place to have details (and that we should fill out more).
Per another PR, I also stumbled across the fact that we have a lot of "string bool" values and cannot be native TOML booleans. Document that clearly next to each type.
We already have default values in the code for all of these, so comment them all out to be consistent with other values. (We're then getting closer to having the config file be entirely comments, but that's a distinct project)
Finally, update the recent man pages I added to match these changes.