-
Notifications
You must be signed in to change notification settings - Fork 141
Expand/consolidate "detecting bootc" #1661
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request consolidates and expands the documentation on detecting bootc systems, which is a helpful clarification. The changes move detection logic into a single file and add more methods. I've found a couple of areas in the new documentation that could be improved for clarity and correctness.
docs/src/package-managers.md
Outdated
If you want to specifically detect if bootc is in use, then | ||
if the binary is present, the following example of | ||
parsing the JSON status will differentiate: | ||
`test $(bootc status --format=json | jq .spec.image) = null`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The phrasing in this new section is a bit ambiguous. The term 'will differentiate' doesn't clearly explain what is being differentiated. For better readability, it would be helpful to explicitly state what this check accomplishes.
Additionally, this section seems to partially duplicate the information in the 'Detecting bootc specifically' section later in this document (lines 86-95). It would be beneficial to consolidate these sections to avoid redundancy and potential confusion for readers.
If you want to specifically detect if bootc is in use, then | |
if the binary is present, the following example of | |
parsing the JSON status will differentiate: | |
`test $(bootc status --format=json | jq .spec.image) = null`. | |
To specifically detect if bootc is in use, you can parse its JSON status | |
(if the binary is present) to tell if a system is tracking an image. | |
The following command succeeds if an image is *not* being tracked: | |
`test $(bootc status --format=json | jq .spec.image) = null`. |
docs/src/package-managers.md
Outdated
|
||
This is created by ostree, and hence created by bootc (with the ostree) | ||
backend. You can use it to detect ostree. However, *most* cases | ||
should instead detect via one of the recomendations above. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Continually comes up. Signed-off-by: Colin Walters <walters@verbum.org>
Continually comes up.