[SSSD] About doxygen

Stephen Gallagher sgallagh at redhat.com
Thu Feb 25 15:15:16 UTC 2010


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 02/25/2010 10:13 AM, John Dennis wrote:
> On 02/25/2010 10:03 AM, Dmitri Pal wrote:
>> Hi Stephen,
>>
>> Several questions regarding the doxygen.
>> I managed to download, build and configure it on CSB to use with
>> collection library. Moving on so:
>> 1) Should the version of the library mentioned in configure.ac match the
>> doc version - I think they should
>> 2) HTML + man pages is what we need, right?
>> 3) How you see it being built? Automatic as a build target "make docs"
>> and be integrated into the build or manually using "make docs" or
>> manually using doxygen directly?
>> 4)  Are we going to check in  the doxygen configuration and generated
>> doc output? If so where? What should be the directory structure?
>> 5) Should the doxygen be a build requirement?
>> 6) Should I create a separate source file(s) to have the tags and
>> descriptions rather than generate the docs from the real reader files so
>> that the headers are clear from tags?
>>
>> There might be more...
>>
> 
> I can't speak for Stephen and don't presume to, but here are my
> thoughts. I think the doc should be built automatically as part of the
> rpm build process. I would suggest adding "make doc" to the %build part
> of the spec. Yes, this does mean the spec will need a buildRequires on
> doxygen. The doxygen config file should be checked into git. The doc
> generated by %build should be installed in the spec file in the %install
> section in %{docdir}. Depending on the size you may want to include this
> in separate doc subpackage, otherwise it should be part of the devel
> subpackage. The reason to always build it is because then it's always
> current acurately reflecting the sources. The extra cycles to build the
> doc during an rpmbuild is minimal compared to the benefits.
> 

This fits in pretty well with my recommended approach. John makes an
excellent point that we should make sure to build and ship the docs in
the -devel subpackages.

+1

- -- 
Stephen Gallagher
RHCE 804006346421761

Delivering value year after year.
Red Hat ranks #1 in value among software vendors.
http://www.redhat.com/promo/vendor/
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.10 (GNU/Linux)
Comment: Using GnuPG with Fedora - http://enigmail.mozdev.org/

iEYEARECAAYFAkuGlAQACgkQeiVVYja6o6PFuwCdEPQ2/DAy6+szctVFLoe6x+4Q
E9AAnizSKThKl9qxuGg4OlMCXoIWNTKB
=PZCE
-----END PGP SIGNATURE-----



More information about the sssd-devel mailing list