diff options
author | Gaetan Nadon <memsize@videotron.ca> | 2014-01-07 14:00:44 -0500 |
---|---|---|
committer | Arnaud Fontaine <arnau@debian.org> | 2014-01-30 12:09:35 +0900 |
commit | 412928f113c8a5e5b30c03a294a42b0b1cf5f5d7 (patch) | |
tree | 58269ea85bc102aed808c0f2c6c25ef882f091ca /doc | |
parent | 9ba6aa759e937e60b231b209b1293a40ad6c7a8a (diff) |
autoconf: use default xorg configuration for doxygen documentation
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>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index dbe2e0b..f3c934a 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -8,7 +8,9 @@ xkb_issues docdirs = $(srcdir)/tutorial -if BUILD_DOCS +if ENABLE_DEVEL_DOCS +if HAVE_DOXYGEN +if HAVE_DOT docdirs += manual @@ -21,6 +23,8 @@ clean-local: rm -rf manual/ endif +endif +endif all-local: $(docdirs) |