unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: Tomi Ollila <tomi.ollila@iki.fi>
To: David Bremner <david@tethera.net>, Jani Nikula <jani@nikula.org>,
	notmuch@notmuchmail.org
Subject: Re: [PATCH v2 0/2] doxygen generated library reference man page
Date: Mon, 06 Jan 2014 11:13:33 +0200	[thread overview]
Message-ID: <m2y52tlbgi.fsf@guru.guru-group.fi> (raw)
In-Reply-To: <87bnzq605g.fsf@zancas.localnet>

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

> Jani Nikula <jani@nikula.org> writes:
>
>> v2 of id:cover.1385826040.git.jani@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

  reply	other threads:[~2014-01-06  9:13 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-01-01 17:52 [PATCH v2 0/2] doxygen generated library reference man page Jani Nikula
2014-01-01 17:52 ` [PATCH v2 1/2] devel: add doxygen configuration file Jani Nikula
2014-01-01 17:52 ` [PATCH v2 2/2] lib: modify notmuch.h for automatic document generation Jani Nikula
2014-01-04  8:16 ` [PATCH v2 0/2] doxygen generated library reference man page Tomi Ollila
2014-01-05 13:14 ` David Bremner
2014-01-06  9:13   ` Tomi Ollila [this message]
2014-01-12  0:12     ` David Bremner
2014-01-12  9:58       ` Tomi Ollila
2014-01-12 12:06         ` David Bremner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://notmuchmail.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=m2y52tlbgi.fsf@guru.guru-group.fi \
    --to=tomi.ollila@iki.fi \
    --cc=david@tethera.net \
    --cc=jani@nikula.org \
    --cc=notmuch@notmuchmail.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).