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.

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

Feature Request: Add man page #269

Closed
c4t3l opened this issue Oct 30, 2021 · 1 comment · Fixed by #270
Closed

Feature Request: Add man page #269

c4t3l opened this issue Oct 30, 2021 · 1 comment · Fixed by #270
Assignees
@c4t3l
Labels
Type: Documentation Type: Enhancement New feature or request

Comments

@c4t3l
Copy link
Contributor

c4t3l commented Oct 30, 2021

Is your feature request related to a problem? Please describe.
I am in the process of getting approval for salt-lint rpm packaging in Fedora. Fedora Packaging Guidelines state that all command line applications should have man pages [1].

Describe the solution you'd like
I can generate a man page based upon the included --help flag with the help of help2man.

Describe alternatives you've considered
I could manually write the man page in troff/groff format, but the above solution would be ideal.

Additional context
N/A

I can create a PR for this issue. What would the appropriate location for the man page to reside? My initial thoughts are in docs/man/salt-lint.1 or similar.
@c4t3l c4t3l added the Type: Enhancement New feature or request label Oct 30, 2021
@c4t3l c4t3l changed the title Please add man page Feature Request: Please add man page Oct 30, 2021
@roaldnefs
Copy link
Member

Thanks @c4t3l for your suggestion. The docs/man/salt-lint.1 locations seems appropriate. If you are indeed willing to create a PR that would be very helpful! 🙌

@roaldnefs roaldnefs changed the title Feature Request: Please add man page Feature Request: Add man page Oct 30, 2021
c4t3l added a commit to c4t3l/salt-lint that referenced this issue Oct 31, 2021
@c4t3l
Added manpage for salt-lint
21e7117 
Fixes warpnet#269
@c4t3l c4t3l mentioned this issue Oct 31, 2021
Merged
c4t3l added a commit to c4t3l/salt-lint that referenced this issue Oct 31, 2021
@c4t3l
Updated file location per warpnet#269.
a063c72
roaldnefs pushed a commit that referenced this issue Nov 1, 2021
@c4t3l
docs: add man page for salt-lint (#270)
545f305 
Add man page for salt-lint.

Fixes #269 

Signed-off-by: Roald Nefs <info@roaldnefs.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@c4t3l c4t3l

Labels
Type: Documentation Type: Enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Added manpage for salt-lint c4t3l/salt-lint
2 participants
@roaldnefs @c4t3l