search

warpnet / salt-lint

A command-line utility that checks for best practices in SaltStack.
https://salt-lint.readthedocs.io/en/latest/
MIT License
154 stars 39 forks source link

Feature Request: Add man page #269

Closed c4t3l closed 3 years ago

c4t3l commented 3 years ago

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.

roaldnefs commented 3 years ago

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! 🙌