Skip to content

Conversation

cgwalters
Copy link
Collaborator

Continually comes up.

@github-actions github-actions bot added the area/documentation Updates to the documentation label Oct 2, 2025
@bootc-bot bootc-bot bot requested a review from jeckersb October 2, 2025 12:39
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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.

Comment on lines 29 to 32
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`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
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`.


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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There's a typo in 'recomendations'.

Suggested change
should instead detect via one of the recomendations above.
should instead detect via one of the recommendations above.

Continually comes up.

Signed-off-by: Colin Walters <walters@verbum.org>
@jeckersb jeckersb merged commit 24f2dd0 into bootc-dev:main Oct 6, 2025
32 of 35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Updates to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants