feat(tools): Introduce tool to generate man pages #2023
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
craciunoiuc
changed the title
|
Nice, thanks for this @teodoradriann Some initial mentions from me:
That's all from my side, after this is done I'll leave some code comments also |
|
Okay, will do and update |
teodoradriann
force-pushed
the
generating_man
branch
from
ca654f0 to
7bde584
Compare
|
Hey @teodoradriann, are you up for some more rounds of reviews or do you want me to take over this PR to get it to shape? Let me know how your availability is looking Edit: I pushed my fixes (hopefully ok with you) |
craciunoiuc
force-pushed
the
generating_man
branch
from
7bde584 to
6331a4b
Compare
nderjung
reviewed
Jan 22, 2025
craciunoiuc
force-pushed
the
generating_man
branch
from
6331a4b to
a87ed38
Compare
This is an initial version of the auto-generator of man pages for kraftkit. This parses help messages and generates man files which can be afterwards installed. To generate them, use the new `make` command `make man`. Signed-off-by: Teodor Adrian Miron <teodormiron75@gmail.com> Signed-off-by: Cezar Craciunoiu <cezar.craciunoiu@unikraft.io>
Signed-off-by: Cezar Craciunoiu <cezar.craciunoiu@unikraft.io>
craciunoiuc
force-pushed
the
generating_man
branch
from
a87ed38 to
7ce3d21
Compare
nderjung
approved these changes
Jan 28, 2025
There was a problem hiding this comment.
Thanks!
Reviewed-by: Alexander Jung alex@unikraft.io
Approved-by: Alexander Jung alex@unikraft.io
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prerequisite checklist
make fmton your commit series before opening this PR;Description of changes
I updated the auto-generating documentation script located at
tools/gendocs/main.goby adding two new functionalities.Now, after compiling the program, you can use one of the following flags:
•
--man or -m:Automatically generates all KraftKit documentation as .1 files, located in kraftkit/doc/man.•
--install or -i:Installs all the files found in the man folder system-wide and updates the mandb.GitHub-Closes: #1704