From: Tomi Ollila <tomi.ollila@iki.fi>
Date: Mon, 6 Jan 2014 09:13:33 +0000 (+0200)
Subject: Re: [PATCH v2 0/2] doxygen generated library reference man page
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=69e15994faad69c112f1efaa38012b7dfdb4977b;p=notmuch-archives.git

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

diff --git a/47/11dd1330fce81ca3330d97d98093a606f440b4 b/47/11dd1330fce81ca3330d97d98093a606f440b4
new file mode 100644
index 000000000..9d3754d39
--- /dev/null
+++ b/47/11dd1330fce81ca3330d97d98093a606f440b4
@@ -0,0 +1,85 @@
+Return-Path: <tomi.ollila@iki.fi>
+X-Original-To: notmuch@notmuchmail.org
+Delivered-To: notmuch@notmuchmail.org
+Received: from localhost (localhost [127.0.0.1])
+	by olra.theworths.org (Postfix) with ESMTP id E87E6431FC2
+	for <notmuch@notmuchmail.org>; Mon,  6 Jan 2014 01:13:50 -0800 (PST)
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org
+X-Spam-Flag: NO
+X-Spam-Score: 0
+X-Spam-Level: 
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]
+	autolearn=disabled
+Received: from olra.theworths.org ([127.0.0.1])
+	by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)
+	with ESMTP id jJSdDzNwGLg7 for <notmuch@notmuchmail.org>;
+	Mon,  6 Jan 2014 01:13:43 -0800 (PST)
+Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])
+	by olra.theworths.org (Postfix) with ESMTP id 38A0D431FBF
+	for <notmuch@notmuchmail.org>; Mon,  6 Jan 2014 01:13:43 -0800 (PST)
+Received: from guru.guru-group.fi (localhost [IPv6:::1])
+	by guru.guru-group.fi (Postfix) with ESMTP id A779710005E;
+	Mon,  6 Jan 2014 11:13:33 +0200 (EET)
+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
+In-Reply-To: <87bnzq605g.fsf@zancas.localnet>
+References: <cover.1388598677.git.jani@nikula.org>
+	<87bnzq605g.fsf@zancas.localnet>
+User-Agent: Notmuch/0.17+15~g4d2c5fa (http://notmuchmail.org) Emacs/24.3.1
+	(x86_64-unknown-linux-gnu)
+X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL
+	$[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F
+	!)g;OY^,BjTbr)Np:%c_o'jj,Z
+Date: Mon, 06 Jan 2014 11:13:33 +0200
+Message-ID: <m2y52tlbgi.fsf@guru.guru-group.fi>
+MIME-Version: 1.0
+Content-Type: text/plain
+X-BeenThere: notmuch@notmuchmail.org
+X-Mailman-Version: 2.1.13
+Precedence: list
+List-Id: "Use and development of the notmuch mail system."
+	<notmuch.notmuchmail.org>
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,
+	<mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>
+List-Post: <mailto:notmuch@notmuchmail.org>
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,
+	<mailto:notmuch-request@notmuchmail.org?subject=subscribe>
+X-List-Received-Date: Mon, 06 Jan 2014 09:13:51 -0000
+
+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