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

Add cpuid man page #14

Closed
Mno-hime opened this issue Jul 28, 2018 · 4 comments
Closed

Add cpuid man page #14

Mno-hime opened this issue Jul 28, 2018 · 4 comments

Comments

@Mno-hime
Copy link

I would be helpful to have cpuid man page.

I created one for the OpenIndiana project based on your README.md: OpenIndiana/oi-userland#4345

The source is cpuid.ronn which can be parsed via ronn to cpuid.1. The latter one can be edited manually as well.

@Mno-hime
Copy link
Author

Will you incorporate the cpuid.1 man page from https://github.com/OpenIndiana/oi-userland/blob/oi/hipster/components/sysutils/cpuid/files/cpuid.1? Otherwise you can close this.

@Mno-hime
Copy link
Author

@tycho ping?

@tycho
Copy link
Owner

tycho commented Jun 11, 2019

Feel free to make a PR out of this:

  • Add another file to use as the man page source, since the existing README.md isn't in an ideal format for use as a man page.
  • Add some new steps in GNUmakefile and meson.build to generate/install a man page. It would need to be an optional step. Perhaps via explicit targets "man" and "install-man" for GNU make, and as a configure-time tool check for Meson? Either way, I certainly don't want to be forced to install the manpage generation tool just because I want to compile cpuid.

@tycho
Copy link
Owner

tycho commented Jun 11, 2019

Also I've just revamped the Travis build stuff and made it more robust (and build on more modern distribution releases). In whatever change you come up with, please ensure that the doc generation gets tested in .travis/script.sh.

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

No branches or pull requests

2 participants