From 412928f113c8a5e5b30c03a294a42b0b1cf5f5d7 Mon Sep 17 00:00:00 2001 From: Gaetan Nadon Date: Tue, 7 Jan 2014 14:00:44 -0500 Subject: 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 Signed-off-by: Gaetan Nadon --- m4/xcb.m4 | 89 --------------------------------------------------------------- 1 file changed, 89 deletions(-) (limited to 'm4') diff --git a/m4/xcb.m4 b/m4/xcb.m4 index ad24bc2..32e852d 100644 --- a/m4/xcb.m4 +++ b/m4/xcb.m4 @@ -31,95 +31,6 @@ extern void f(int); CFLAGS=${save_CFLAGS} ]) -dnl Configure script for doxygen -dnl Vincent Torri 2006-05-11 -dnl -dnl XCB_CHECK_DOXYGEN([ACTION-IF-FOUND [, ACTION-IF-NOT-FOUND]]) -dnl Test for the doxygen program, and define BUILD_DOCS and DOXYGEN. -dnl -AC_DEFUN([XCB_CHECK_DOXYGEN], -[ -DOXYGEN="doxygen" - -dnl -dnl Disable the build of the documentation -dnl -AC_ARG_ENABLE( - [build_docs], - AC_HELP_STRING( - [--disable-build-docs], - [Disable the build of the documentation]), - [if test x"$enableval" != x"yes" ; then - enable_build_docs="no" - else - enable_build_docs="yes" - fi], - [enable_build_docs="yes"]) - -if test "$enable_build_docs" = "no" ; then - BUILD_DOCS=no -else -dnl -dnl Get the prefix where doxygen is installed. -dnl -AC_ARG_WITH( - [doxygen], - AC_HELP_STRING( - [--with-doxygen=FILE], - [doxygen program to use (eg /usr/bin/doxygen)]), - dnl - dnl Check the given doxygen program. - dnl - [DOXYGEN=${withval} - AC_CHECK_PROG( - [BUILD_DOCS], - [${DOXYGEN}], - [yes], - [no]) - if test $BUILD_DOCS = no; then - echo "WARNING:" - echo "The doxygen program you specified:" - echo "$DOXYGEN" - echo "was not found. Please check the path and make sure " - echo "the program exists and is executable." - AC_MSG_WARN( - [Warning: no doxygen detected. Documentation will not be built]) - fi], - [AC_CHECK_PROG( - [BUILD_DOCS], - [${DOXYGEN}], - [yes], - [no]) - if test ${BUILD_DOCS} = no; then - echo "WARNING:" - echo "The doxygen program was not found in your execute" - echo "You may have doxygen installed somewhere not covered by your path." - echo "" - echo "If this is the case make sure you have the packages installed, AND" - echo "that the doxygen program is in your execute path (see your" - echo "shell manual page on setting the \$PATH environment variable), OR" - echo "alternatively, specify the program to use with --with-doxygen." - AC_MSG_WARN( - [Warning: no doxygen detected. Documentation will not be built]) - fi]) - AC_PATH_PROG(DOT, dot, no) - if test "$DOT" = "no"; then - AC_MSG_WARN([Warning: no dot detected. Documentation will not be built]) - BUILD_DOCS="no" - fi -fi -AC_MSG_CHECKING([whether documentation is built]) -AC_MSG_RESULT([${BUILD_DOCS}]) - -dnl -dnl Substitution -dnl -AC_SUBST([DOXYGEN]) - -AM_CONDITIONAL(BUILD_DOCS, test "x$BUILD_DOCS" = "xyes") - -]) - dnl Detection and configuration of the visibility feature of gcc dnl Vincent Torri 2006-02-11 dnl -- cgit v1.2.3