Skip to content
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.

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

feat(tools): Introduce tool to generate man pages #2023

Open
wants to merge 1 commit into
base: staging
Choose a base branch
from

Conversation

teodoradriann
Copy link

@teodoradriann teodoradriann commented Dec 14, 2024

Prerequisite checklist

  • Read the contribution guidelines regarding submitting new changes to the project;
  • Tested your changes against relevant architectures and platforms;
  • Ran make fmt on your commit series before opening this PR;
  • Updated relevant documentation.

Description of changes

I updated the auto-generating documentation script located at tools/gendocs/main.go by 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.

SCR-20241218-qbxe SCR-20241218-qbzu SCR-20241218-qccw

GitHub-Closes: #1704

@craciunoiuc craciunoiuc changed the title Generating man feat(tools): Introduce tool to generate man pages Dec 15, 2024
@craciunoiuc craciunoiuc marked this pull request as draft December 17, 2024 10:23
@craciunoiuc
Copy link
Member

craciunoiuc commented Dec 17, 2024

Nice, thanks for this @teodoradriann

Some initial mentions from me:

  1. Can you squash your commits and tidy them up? I think 1-2 commits are fine for this use case. I edited your PR title, I guess you can use that one also.
  2. Can you move your changes from gendocs to a separate tools/genman/main.go. The gendocs tool is used for the website to generate things in a certain format. Just copy your things to the separate file and delete everything gendocs-related.
  3. Add some pictures with the result to the PR description.

That's all from my side, after this is done I'll leave some code comments also

@teodoradriann
Copy link
Author

Okay, will do and update

@teodoradriann teodoradriann marked this pull request as ready for review December 18, 2024 16:27
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.

Add man pages for kraftkit
2 participants