On Wed, 2011-02-16 at 07:46 +1000, Peter Hutterer wrote:

> fwiw, I hadn't planned to actually require doxygen for the build,
> merely
> that the comments are present. but with the above - hey, why not ;)
> 

The server is using it in /home/nadon/xorg/src/xserver/hw/dmx/doc.
Disregard the dmx and scaled targets in that makefile.
The makefile and testing can be simplified by not adding the generated
html in the tarball.

One can turn off all developers doc with --disable-devel-docs (for now
you only have doxygen)

The API docs will be skipped automatically if Doxygen is missing or not
at the right level
One can turn off Doxygen using --without-doxygen (and still get the rest
of devel docs, if any)

One benefit of using these macros is they all work same in all of X.Org.
Distro builders
have (or will) come to expect modules to behave the same way,
documentation wise.

In configure.ac:

        XORG_ENABLE_DEVEL_DOCS
        XORG_WITH_DOXYGEN(1.6.1)


In the doc/Makefile.am:

        if ENABLE_DEVEL_DOCS
        if HAVE_DOXYGEN
        [...]
        endif
        endif


./configure --help:

        Optional Packages:
          [...]
          --with-doxygen          Use doxygen to regenerate documentation 
(default:
                                  auto)



X.Org document classification - from 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.






Attachment: signature.asc
Description: This is a digitally signed message part

------------------------------------------------------------------------------
The ultimate all-in-one performance toolkit: Intel(R) Parallel Studio XE:
Pinpoint memory and threading errors before they happen.
Find and fix more than 250 security defects in the development cycle.
Locate bottlenecks in serial and parallel code that limit performance.
http://p.sf.net/sfu/intel-dev2devfeb
_______________________________________________
Linuxwacom-devel mailing list
Linuxwacom-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/linuxwacom-devel

Reply via email to