Skip to content

Switch to hand-written man pages with auto option sync #1587

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Sep 12, 2025
Merged

Switch to hand-written man pages with auto option sync #1587

merged 1 commit into from
Sep 12, 2025

Conversation

cgwalters
Copy link
Collaborator

See the updates to Justfile for how to use this.

Closes: #1428

Assisted-By: Claude Code (opus + sonnet)

@bootc-bot bootc-bot bot requested a review from jeckersb September 5, 2025 15:17
@cgwalters cgwalters force-pushed the bootc.man branch 4 times, most recently from 78feb5a to a111f83 Compare September 5, 2025 19:04
@cgwalters
Copy link
Collaborator Author

Besides closing the formatting bug, the big thing here is we can write a lot more text in the command man page. There's a lot of overlap between the currently hand-written docs/src/bootc-install.md and the formerly auto-generated docs/src/bootc-install.md. This PR doesn't rectify that, but what I want to do is basically fold the two together for the most part.

@cgwalters cgwalters marked this pull request as ready for review September 5, 2025 19:10
@gursewak1997
Copy link
Contributor

Changes look good. CI fails with

error: Packaging
Caused by:
    0: Converting docs/src/man/bootc.md to man page
    1: command not found: `pandoc`

@cgwalters cgwalters force-pushed the bootc.man branch 2 times, most recently from f4d712b to 93c164d Compare September 5, 2025 22:34
@cgwalters
Copy link
Collaborator Author

OK this is now architecturally closer to what's happening in e.g. https://github.com/containers/netavark/blob/main/docs/Makefile

A nice thing is we can replace pandoc with go-md2man which is way simpler of a project now that we don't need to have a crazy chain of Rust → man → markdown.

@cgwalters cgwalters force-pushed the bootc.man branch 3 times, most recently from ec59aad to 4075943 Compare September 12, 2025 12:27
@cgwalters cgwalters enabled auto-merge September 12, 2025 12:27
@cgwalters cgwalters disabled auto-merge September 12, 2025 12:29
cgwalters
cgwalters commented Sep 12, 2025
View reviewed changes
@cgwalters
Copy link
Collaborator Author

OK this one should be ready for review!

@gursewak1997
Copy link
Contributor

Is there a reason we cancelled the CI runs?
Errors on
Problem: cannot install both ostree-libs-2025.4-2.el9.aarch64 from appstream and ostree-libs-2025.6-1.el9.aarch64 from @System

@cgwalters
Copy link
Collaborator Author

The GHA matrix there defaults to fail-fast; maybe we could change that. Anyways rebased on #1609

@cgwalters cgwalters enabled auto-merge September 12, 2025 20:13
@cgwalters
Switch to hand-written man pages with auto option sync
d438aaf 
See the updates to `Justfile` for how to use this.

Closes: bootc-dev#1428

Assisted-By: Claude Code (opus + sonnet)
Signed-off-by: Colin Walters <walters@verbum.org>
@cgwalters cgwalters merged commit f4dfd81 into bootc-dev:main Sep 12, 2025
58 of 60 checks passed
@cgwalters
Copy link
Collaborator Author

Fallout in #1616

cgwalters added a commit to cgwalters/bootc that referenced this pull request Sep 17, 2025
@cgwalters
docs: Fix links to man pages
3fa6608 
Followup to bootc-dev#1587
Closes: bootc-dev#1616
@cgwalters cgwalters mentioned this pull request Sep 17, 2025
Merged
cgwalters added a commit to cgwalters/bootc that referenced this pull request Sep 17, 2025
@cgwalters
docs: Fix links to man pages
a93d32b 
Followup to bootc-dev#1587
Closes: bootc-dev#1616

Signed-off-by: Colin Walters <walters@verbum.org>
cgwalters added a commit to cgwalters/bootc that referenced this pull request Sep 17, 2025
@cgwalters
docs: Fix links to man pages
f6c400d 
Followup to bootc-dev#1587
Closes: bootc-dev#1616

Signed-off-by: Colin Walters <walters@verbum.org>
cgwalters added a commit to cgwalters/bootc that referenced this pull request Sep 17, 2025
@cgwalters
docs: Fix links to man pages
2ca2886 
Followup to bootc-dev#1587
Closes: bootc-dev#1616

Signed-off-by: Colin Walters <walters@verbum.org>
@travier travier mentioned this pull request Sep 18, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gursewak1997 gursewak1997 gursewak1997 approved these changes

@jeckersb jeckersb Awaiting requested review from jeckersb

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

move to hand written man pages with automatic sync
2 participants
@cgwalters @gursewak1997