Maintaining either requires full knowledge of both.
It's not obvious one has to check the usage of global variables
in devbook.am when maintaining doxygen target. Or vice-versa.
Being in their respective directory, one less thing to worry about.
Reviewed-by Jeremy Huddleston <jeremyhu@apple.com>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Keith Packard <keithp@keithp.com>
The user/specs docs now have external references support.
Developers doc are not installed so they do not participate.
However, using a similar makefile shared amongst developers
document reduces maintenance and is forward looking.
Reviewed-by Jeremy Huddleston <jeremyhu@apple.com>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Keith Packard <keithp@keithp.com>
This was leftover from some older ways of building dmx/scale docbook.
Reviewed-by: Dan Nicholson <dbn.lists@gmail.com>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Keith Packard <keithp@keithp.com>
Instead of listing one of the doxygen output files and depending on
sequential execution to ensure that the other files were present
before make checked for them, create explicit dependencies so that
make will not check for the additional files until after doxygen has
been run.
This allows parallel make to work correctly in this directory.
Signed-off-by: Keith Packard <keithp@keithp.com>
Tested-by: Kristian Høgsberg <krh@bitplanet.net>
The paths in doxygen.conf assumed that srcdir=builddir and broke
otherwise. Use autoconf to fill in the paths to the srcdir so that the
files can be found when users have a separate build directory (as with
distcheck).
Signed-off-by: Dan Nicholson <dbn.lists@gmail.com>
Tested-by: Cyril Brulebois <kibi@debian.org>
Reviewed-by: Gaetan Nadon <memsize@videotron.ca>
Tested-by: Sedat Dilek <sedat.dilek@gmail.com>
Use the util-macros AM Conditionals to control generation of developers
documents. This is used throughout xorg modules.
The doxygen generated docs are now also managed by --enable-devel-docs.
Remove --enable-builddocs as this was last use for BUILDDOCS
*** From the RELEASE NOTES ***
New configure options for documentation in modules
--------------------------------------------------
As many more modules now contain documentation to be converted from DocBook XML to text,
HTML, PostScript, and/or PDF formats, new standard options have been added to the configure
macros to control the build of these in the modules.
--with-xmlto=yes|no
Enables or disables use of the xmlto [https://fedorahosted.org/
xmlto/] command to translate DocBook XML to other formats.
All DocBook XML conversions require use of this command.
--with-fop=yes|no
Enables or disables use of the Apache fop [http://
xmlgraphics.apache.org/fop/] command to translate DocBook
XML to PostScript and PDF formats.
--enable-docs=yes|no
Enables or disables the build and installation of all
documentation except traditional man pages or those covered
by the --enable-devel-docs and --enable-specs options.
--enable-devel-docs=yes|no
Enables or disables the build and installation of documentation
for developers of the X.Org software modules.
--enable-specs=yes|no
Enables or disables the build and installation of the formal
specification documents for protocols and APIs.
Reviewed-by: Tiago Vignatti <tiago.vignatti@nokia.com>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Keith Packard <keithp@keithp.com>
A different approach which requires less variables setting
and internal knowledge of the reused code.
Changing from "install" to "not install" is very easy now.
Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Keith Packard <keithp@keithp.com>
Relative paths don't always work in distcheck when srcdir not = builddir
include $(top_srcdir)/doc/xml/xmlrules.in
Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Keith Packard <keithp@keithp.com>
Only the markup/formatting is changed - the contents should still
be wildly out of date for now.
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Reviewed-by: Rémi Cardona <remi@gentoo.org>
Tested-by: Gaetan Nadon <memsize@videotron.ca>
XORG_WITH_DOXYGEN provides additional functions like a configure
option which allow platform builders to control the usage of
the doxygen program.
This is a requirement from platforms that do not have such doc tool.
A platform with a back level doxygen may use --without-doxygen
to get the rest of the documentation built.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Signed-off-by: Keith Packard <keithp@keithp.com>
Ok, dmx docs are driving me slightly nuts. We probably shouldn't
include the built versions in the tarball, but we do, so this is an
attempt to make that work by having both the 'all' and 'dist' targets
depends on the doxygen output.
Signed-off-by: Keith Packard <keithp@keithp.com>
These can be recreated by simply running 'doxygen doxygen.conf' in
hw/dmx/doc. Some of the files do not exist anymore, these have been removed.
Some other files have a different naming scheme.
Doxygen warnings about missing links fixed, two warnings remain:
/home/whot/xorg/xserver/hw/dmx/dmxwindow.c:142: Warning: explicit link
request to 'dmxConfigureRootWindow' could not be resolved
/home/whot/xorg/xserver/hw/dmx/dmxwindow.c:119: Warning: explicit link
request to 'dmxConfigureScreenWindow()' could not be resolved
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
