[PATCH v2 0/2] doxygen generated library reference man page

Tomi Ollila tomi.ollila at iki.fi
Mon Jan 6 01:13:33 PST 2014


On Sun, Jan 05 2014, David Bremner <david at tethera.net> wrote:

> Jani Nikula <jani at nikula.org> writes:
>
>> v2 of id:cover.1385826040.git.jani at nikula.org
>>
>> Rebase, minor tweaks since v1; the TODO in the referenced message above
>> is still valid. I suggest we get this merged as a starting point, so we
>> can collaborate on including a nice API man page (and possibly a HTML
>> API reference on the web page) for 0.18.
>>
>
> I pushed these.
>
> Should we start installing the generated man page?

One thing to bikeshed:

IMO "install" target should not execute anything that is located in
'devel/' (i.e. build should be "devel/" -free) so IMO the doxygen.cfg
should be moved to some other directory
(but where? to the root? to man/* to upcoming info/*?)

Also, I attempted to split the version from PROJECT_NAME to 
PROJECT_NUMBER in doxygen.cfg -- The generated file had 'Version 0.17 ...'
instead of 'Notmuch 0.17 ...' as the last line. Therefore I think the
choice of keeping PROJECT_NAME = "Notmuch $VERSION" instead of moving
the $VERSION to PROJECT_NUMBER is a good idea. IMO this choice should be
commented in doxygen.cfg but that is probably not going to happen ;/

> d

Tomi


More information about the notmuch mailing list