-
Notifications
You must be signed in to change notification settings - Fork 7
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
Man pages missing #40
Comments
Just a observation in this repository there is no |
What can I do to help here? |
The best thing would be for the man pages to be included with the tarball form cfengine. Do you know why they're missing? |
Oops, wrong button, sorry |
IIRC the man pages are supposed to be in the package, but don't know about the tarball. I think they can be generated from source, either way. @nickanderson @vohi @cduclos can you comment please? |
In the 3.5.x and master branch there is the directory:
|
Debian imports from the tar all though, not the upstream repo. |
@bahamat i know we fetch the tarball. I assume that the generation of the tarball goes wrong and does not include the docs directory. |
The man pages for the binaries are generated by the binaries themselves, via (undocumented) -M command line parameter. There are no man-pages checked into the repository (https://github.com/cfengine/core/tree/master/docs/manpages). They can't be in the tar ball for that reason, because we don't compile the binaries before we generate the tar ball. There's https://cfengine.com/dev/issues/2989 as a known issue in our own packages. |
Ok, that makes a bit more sense. We can add a build step that generates and saves them. |
Cool, now it makes sense, thanks @vohi |
Ted suggested using an acceptance test to create the man pages because the tests already know how to execute the binaries properly. |
This patch successfully produces man pages, although I don't think this is the best approach. Any suggestions on improving this?
There's still no man page for |
@bahamat maybe this:
I tested this and it works. |
Excellent, thanks. I'll use that. |
I have issued sn pull request #51 |
and applied |
The man pages in community edition are in
/var/cfengine/share/man/man8/
.I don't know yet if they're in the package and not in the right place, or missing entirely. I wanted to get this in while it was on my mind.
The text was updated successfully, but these errors were encountered: