jsonnet icon indicating copy to clipboard operation
jsonnet copied to clipboard

doc/man: Add man pages jsonnet.1 and jsonnetfmt.1

Open daichifukui opened this issue 10 months ago • 2 comments

Hi

With this commit, we'd like to add man pages for the jsonnet and jsonnetfmt commands. The Debian Lintian quality checker warns that each binary should have a manual page, but hopefully this idea would also apply to non-Debian users. These man pages are created using the help2man command, so the contents are substantially the same as the output of the help option.

daichifukui avatar Jan 26 '25 13:01 daichifukui

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

google-cla[bot] avatar Jan 26 '25 13:01 google-cla[bot]

It looks like this is the output of the help2man tool. What were the exact commands you used to generate this? It's important to be able to re-run this when needed. For example, if command line argumments to jsonnet or jsonnetfmt change, but also whenever there is a new release we'll need to regenerate this since the man page includes the version number.

It would be good to either generate the man pages during the build (and not add them in the repository at all), or at least to have a make target or shell script that can be run to repeatably regenerate the man-pages (and add it to the release checklist)

johnbartholomew avatar Feb 18 '25 16:02 johnbartholomew

Hi @johnbartholomew , I've updated this change to generate the man pages during the build. For the exact commands used to generate the man pages, take a look at the files changed. I'd be happy if you will approve this. Thank you for the review.

daichifukui avatar Jul 05 '25 02:07 daichifukui