Skip to content

Conversation

cgwalters
Copy link
Collaborator

Followup to #1587 Closes: #1616

@cgwalters cgwalters enabled auto-merge September 17, 2025 14:53
@github-actions github-actions bot added documentation control/skip-ci Do not run expensive CI on this job labels Sep 17, 2025
@bootc-bot bootc-bot bot requested a review from jeckersb September 17, 2025 14:53
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 fixes broken links to man pages across the documentation by updating filenames to include man page sections and correcting paths. The changes are mostly correct and improve the documentation's usability. I've added a couple of comments on docs/src/SUMMARY.md to point out some remaining inconsistencies in the content of two of the newly linked man pages for the sake of completeness. Addressing these would make the documentation fully consistent.

@jeckersb
Copy link
Collaborator

Not sure if I'm running this wrong with the new process, but I'm seeing this error trying to sanity check this:

$ just update-generated
[...]
Man pages updated.

Next steps for new templates:
   - Edit the templates to add detailed descriptions and examples
   - Run 'cargo xtask manpages' to generate final man pages

Updated docs/src/host-v1.schema.json
Updated docs/src/progress-v0.schema.json

I am assuming I am supposed to run cargo xtask manpages here, given the above output?

$ cargo xtask manpages
[...]
error: Man page filename must include section number (e.g., bootc.8.md, bootc-config.5.md): bootc-upgrade.md

@cgwalters cgwalters force-pushed the fix-man-sync branch 2 times, most recently from 820f71d to 0288b50 Compare September 17, 2025 20:51
@cgwalters
Copy link
Collaborator Author

OK yeah, there was some cruft and bugs here. Pushed another commit that fixes more things.

@cgwalters
Copy link
Collaborator Author

Now probably what might make sense is to try to extract this code into a standalone crate to replace https://docs.rs/clap_mangen/latest/clap_mangen/ for those who want what we're doing here (combining hand-maintained dedicated markdown with auto-generated options).

Followup to bootc-dev#1587
Closes: bootc-dev#1616

Signed-off-by: Colin Walters <walters@verbum.org>
@cgwalters cgwalters force-pushed the fix-man-sync branch 2 times, most recently from a5c8638 to 00a3ef3 Compare September 18, 2025 11:25
- Remove duplicated logic between xtask and makefile
  for converting markdown; it needs to be in xtask
  as we handle the version substitution there and
  some other tweaks
- Really just make the developer entrypoint `just update-generated`
  in general
- Fix the rendering of booleans
- Remove unnecessary emoji from prints

Signed-off-by: Colin Walters <walters@verbum.org>
@cgwalters cgwalters merged commit 2cb69c1 into bootc-dev:main Sep 18, 2025
54 of 60 checks passed
@jeckersb jeckersb mentioned this pull request Sep 18, 2025
@cgwalters
Copy link
Collaborator Author

cgwalters commented Sep 18, 2025

For the record what happened here is this one originally got a "control/skip-ci" label as it only affected docs, then it changed to change the code, but that didn't remove the label.

image

@cgwalters
Copy link
Collaborator Author

#1627

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
control/skip-ci Do not run expensive CI on this job
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Most generated man pages are empty
2 participants