No content or form changes for the xcb manual or tutorial.
Only the configuration user visible bits change.
Xcb will now have the same configuration options as the 30 other
xorg modules.
Xorg classifies documentation as "user", "developer" or "specifications".
The xcb manual falls under the "developer" category. Developers docs
are never installed under $prefix.
A builder can selectively turn on/off any or all of the categories. He can
also selectively turn on/off any of the many tools used to generate
documentation such as doxygen, xmlto, etc... Each tool has an environment
variable defined such as DOXYGEN.
Other features are available, the user interface and the functionality
is the same on all modules.
--with-doxygen=FILE is replaced with DOXYGEN env variable
--disable-build-docs is replaced with --disable-devel-docs
The new interface displayed with ./configure --help:
--enable-devel-docs Enable building the developer documentation
(default: yes)
--with-doxygen Use doxygen to regenerate documentation (default:
auto)
DOXYGEN Path to doxygen command
DOT Path to the dot graphics utility
The dot tool checking has been added to util-macros in version 1.18.
Refer to the table of existing docs in xorg.
XCB will be added for the doxygen generated API manual.
Reviewed-by: Josh Triplett <josh@joshtriplett.org>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Specifically, they didn't handle installing data from both srcdir and builddir.
We have the tutorial in the srcdir, and build the manual in the builddir.
Also, stop rebuilding the manual for each make target in the doc directory, and
every time any of those targets get called. This change now makes the manual
never rebuild once built; we plan to fix that later, by rewriting the makefiles
to avoid recursive make, and then making the manual depend on the source files.
Commit by Jamey Sharp and Josh Triplett.
The documentation generation with doxygen now works when built out of tree,
with srcdir != builddir. xcb.doxygen now gets generated from xcb.doxygen.in,
so that it can use top_builddir and top_srcdir to find source and to output
documentation. Also fill in PROJECT_NUMBER from @VERSION@, now that we have
it readily available via autoconf.
Don't override the default htmldir with an unquoted copy.
Don't suppress `make` echoing on Doxygen commands.
Ensure the tutorial is always installed even if Doxygen isn't
available.
Take better advantage of the automake installation infrastructure.
Gaetan Nadon
Arnaud Fontaine
Josh Triplett
Jamey Sharp
TORRI Vincent