[PATCH xorg-docs 2/3] config: use the XORG_ENABLE_DOCS macro to control docs building

[Gaetan Nadon]

On Mon, 2010-09-13 at 12:16 -0700, Jeremy Huddleston wrote:

> So --disable-docs in this case means nothing is installed?
> 

That's the general idea of this XORG_ENABLE_DOCS. Each module can decide
of the exact meaning of what constitute a "document". For xorg-docs, the
MAINTAINERS file may be installed anyway. This macro was born in the
context of using the doc toolchain, like groff, xmlto, doxygen, ps2pdf,
fop and the likes. A builder could disable all documentation in one go
rather than inspecting which tool is used and turn off the tools. A
builder can turn off an individual tool  if it is known to be present
but broken. There is a lot of flexibility now. I wish I can find a way
to document this.

        --enable-docs    Enable building the documentation (default: yes)

There 3 broad categories of documents: "doc", "specs" and "devel-docs"
which have corresponding macros:

        XORG_ENABLE_DOCS
        XORG_ENABLE_SPECS
        XORG_ENABLE_DEVEL_DOCS

Typically devel-docs are not installed. For a complete list, see wiki
http://www.x.org/wiki/Development/Documentation/WritingDocumentation

Some accept a minimum version number:

        XORG_WITH_XMLTO(0.0.20)


Gaetan


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.x.org/archives/xorg-devel/attachments/20100913/0cf7d8b6/attachment.htm>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 197 bytes
Desc: This is a digitally signed message part
URL: <http://lists.x.org/archives/xorg-devel/attachments/20100913/0cf7d8b6/attachment.pgp>