Skip to content

Conversation

@mskott
Copy link
Contributor

@mskott mskott commented Dec 20, 2024

I have started writing man pages for podman-bootc using Podman's man pages as a template.

Still a work in progress, but opening the pull request early to attract input and comments from others.

@rhatdan
Copy link
Contributor

rhatdan commented Dec 20, 2024

Looks good, I would steal these scripts from RamaLama and add them to podman-bootc.

$ ls hack/xref-helpmsgs-manpages hack/man-page-checker
hack/man-page-checker hack/xref-helpmsgs-manpages

@rhatdan
Copy link
Contributor

rhatdan commented Dec 20, 2024

Then add them to makefile and tests ,to make sure you man pages stay in good shape.

@mskott
Copy link
Contributor Author

mskott commented Dec 20, 2024

Then add them to makefile and tests ,to make sure you man pages stay in good shape.

Thanks for the tip. Think I'll borrow their Makefile for docs too since it looks a lot less hairy than podman's

mskott added 6 commits January 2, 2025 11:57
Mostly based on what can be found in -h, but now there is something to
build upon

Signed-off-by: Martin Skøtt <[email protected]>
Also remove some old cruft from the script.

Signed-off-by: Martin Skøtt <[email protected]>
Signed-off-by: Martin Skøtt <[email protected]>
@mskott
Copy link
Contributor Author

mskott commented Jan 20, 2025

I'm pretty happy with the state of the man pages now, but I could use a hand with getting the man pages included in the RPM file, as I have never written a spec before

@germag
Copy link
Collaborator

germag commented Jan 20, 2025

I'm pretty happy with the state of the man pages now, but I could use a hand with getting the man pages included in the RPM file, as I have never written a spec before

Give it a try (I'm not an expert either), you just need to add an install command bellow %install section, under %{_mandir} directory, something like (not tested):

install -m 0644 -vp %{gobuilddir}/doc/* %{buildroot}%{_mandir}/man1

or if the man is installed by make, just add the man files below %files section

%{_mandir}/man1/podman-bootc* 

we need to do this even with the install command

@germag
Copy link
Collaborator

germag commented Jan 20, 2025

Just a minor thing, all the man pages seems to belong to man's section 1 (man1), but the Makefile also have a rule for section 5. Is that correct?

@mskott
Copy link
Contributor Author

mskott commented Jan 20, 2025

Just a minor thing, all the man pages seems to belong to man's section 1 (man1), but the Makefile also have a rule for section 5. Is that correct?

Correct, I adapted the makefile from ramalama and chose to keep the section 5 bits there for when podman-bootc gains a configuration file

@germag
Copy link
Collaborator

germag commented Jan 22, 2025

Just a minor thing, all the man pages seems to belong to man's section 1 (man1), but the Makefile also have a rule for section 5. Is that correct?

Correct, I adapted the makefile from ramalama and chose to keep the section 5 bits there for when podman-bootc gains a configuration file

Hmm I think I prefer to just add what is needed now, because I don't think we will have a conf file in the near future. Moreover, we are working to integrate podman-bootc into podman, so in the case we do need a conf file, it will be part of podman.

@mskott mskott marked this pull request as ready for review January 27, 2025 12:35
@mskott
Copy link
Contributor Author

mskott commented Jan 27, 2025

Although CI is failing due to issues with go mod vendor I believe this PR is ready for review and possibly merge. The man pages are included in the RPM package when building it locally.

@mskott mskott mentioned this pull request Jan 30, 2025
@germag germag merged commit 9a1a0db into bootc-dev:main Feb 10, 2025
1 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants