[PATCH xkeyboard-config] Use XSL to generate man page from the rules XML

Dan Nicholson dbn.lists at gmail.com
Fri Jun 10 10:31:26 PDT 2011


On Thu, Jun 9, 2011 at 10:45 PM, Peter Hutterer
<peter.hutterer at who-t.net> wrote:
> Generate a man-page from the evdev.xml through the xslt/man.xsl stylesheet.
>
> Adds a requirement on the xorg util-macros and xsltproc.
>
> Signed-off-by: Peter Hutterer <peter.hutterer at who-t.net>
> ---
> Taking this from a private thread to a public (archived!) list. Last
> argument of discussion was whether to distribute the man pages with the
> tarball or let the user build them (adding the requirement of xsltproc to
> build from the tarball). I don't care either way and Gaetan indicated that
> there are a few painful points when distributing generate man pages. So
> I say, screw it, let the users do it.

I used to do packaging/building, so a lot of times I come with the
view of not requiring extra dependencies for tarball users. Especially
for documentation since you really want the users to have the docs.
That said, trying to distribute generated files while handling
conditional tools adds a lot more cases to handle. Instead of one (you
have the tool, so you generate the file), you have four with the
combination of tarball vs git and tool vs. no tool. I've thought
through how that works before, so I tend to not think it's that
difficult.

Lately I've come around to the other side more, and these aren't
difficult dependencies to fulfill. It doesn't even require a working
docbook configuration, which can be a huge PITA. So, I'm OK with
keeping it simple and requiring xsltproc to get the man page.

The rest of the patch looks nice and even contains some more goodness
in the xsl from the version I looked at the other day. The only
further improvement I'd suggest is using more embedded groff to format
the tables. But that can come later if someone feels like it.

Reviewed-by: Dan Nicholson <dbn.lists at gmail.com>


More information about the xorg-devel mailing list