feat(cli): add man page generation via make manpage#73
Open
Kshitij-K-Singh wants to merge 1 commit into
Open
Conversation
Signed-off-by: Kshitij-K-Singh <kshitijk.singh.min24@itbhu.ac.in>
|
🚀 First PR — welcome aboard! A few things to expect:
If you get stuck, reply here or jump to Discussions. We want this PR to land. |
Member
|
add screenshort of manpage.. ill then review techinal part |
Author
Attached the screenshot @btwshivam
|
This file contains hidden or 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
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.

What
Add
make manpagetarget to generate man pages for all CLI commands using Cobra's built-indoc.GenManTree.Why
Distribution of kerno as a system tool (deb/rpm/Homebrew) expects
/usr/share/man/man1/kerno.1.gzto exist. Cobra's doc package auto-generates man pages from the command tree — always in sync, no hand-written troff.Fixes #15
How
cmd/kerno-mangen/main.gousingcobra/doc.GenManTreekerno-doctor.1instead ofkernodoctor.1)manpage:target to Makefiledocs/man/*.1to .gitignore (regeneratable artifacts)make manpagein build targetsgithub.com/spf13/cobra/docis already part of the cobra moduleTesting
go build ./...passesgo test ./...passesgo vet ./...passesgolangci-lint run ./...passessudo ./bin/bpf-verify --read 5sconfirms 6/6 programs still load./scripts/verify.shpasses (or specific phase:./scripts/verify.sh quality)Checklist
feat(scope): subject)git commit -s)scripts/verify.sh