From: Tomi Ollila <tomi.ollila@iki.fi>
Date: Wed, 1 Jan 2014 14:15:55 +0000 (+0200)
Subject: Re: [PATCH 0/2] library reference man page
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=64b69d91f55d236e89eae701544bc2f6979823fa;p=notmuch-archives.git

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

diff --git a/0b/5e99ac1a73300e7afc36cdbf9765a8ee819e2a b/0b/5e99ac1a73300e7afc36cdbf9765a8ee819e2a
new file mode 100644
index 000000000..6019eb051
--- /dev/null
+++ b/0b/5e99ac1a73300e7afc36cdbf9765a8ee819e2a
@@ -0,0 +1,90 @@
+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 C6E40431FC0
+	for <notmuch@notmuchmail.org>; Wed,  1 Jan 2014 06:16:10 -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 Az01wVNNV8VG for <notmuch@notmuchmail.org>;
+	Wed,  1 Jan 2014 06:16:04 -0800 (PST)
+Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])
+	by olra.theworths.org (Postfix) with ESMTP id 839C4431FAF
+	for <notmuch@notmuchmail.org>; Wed,  1 Jan 2014 06:16:04 -0800 (PST)
+Received: from guru.guru-group.fi (localhost [IPv6:::1])
+	by guru.guru-group.fi (Postfix) with ESMTP id 639B81000B2;
+	Wed,  1 Jan 2014 16:15:56 +0200 (EET)
+From: Tomi Ollila <tomi.ollila@iki.fi>
+To: Jani Nikula <jani@nikula.org>, David Bremner <david@tethera.net>,
+	notmuch@notmuchmail.org
+Subject: Re: [PATCH 0/2] library reference man page
+In-Reply-To: <87r49xshd4.fsf@nikula.org>
+References: <cover.1385826040.git.jani@nikula.org>
+	<87haat4pws.fsf@zancas.localnet> <87r49xshd4.fsf@nikula.org>
+User-Agent: Notmuch/0.17+13~gdfcf116 (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: Wed, 01 Jan 2014 16:15:55 +0200
+Message-ID: <m261q3pz38.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: Wed, 01 Jan 2014 14:16:10 -0000
+
+On Sat, Nov 30 2013, Jani Nikula <jani@nikula.org> wrote:
+
+> On Sat, 30 Nov 2013, David Bremner <david@tethera.net> wrote:
+>> Jani Nikula <jani@nikula.org> writes:
+>>>
+>>>  devel/doxygen.cfg | 1890 +++++++++++++++++++++++++++++++++++++++++++++++++++++
+>>>  lib/notmuch.h     |  436 ++++++++----
+>>
+>> A 2K line config file is kindof gross, but other than that, I think the
+>> idea has merit. Do we really need that much configuration info?
+>
+> The config file is basically a template generated with 'doxygen -g' and
+> adjusted to our needs. It could be significantly reduced by dropping
+> comments, defaults, and unused settings. Maybe that would be the right
+> thing to do, even if the comments and defaults that are set explicitly
+> serve as documentation.
+>
+>> Perhaps a quibble, but at least for me the summary part of the resulting
+>> manpage is almost unreadable because of the amount of underlining.
+>
+> Agreed, it's not optimal. I was hoping someone more experienced with
+> doxygen would fix that after I shared this initial work. ;)
+
+$ doxygen -g -s
+...
+$ wc Doxyfile
+  305   861 10677 Doxyfile
+
+;)
+
+Maybe keeping the defaults is better than hassle with just the changed
+options ?
+
+
+> BR,
+> Jani.
+
+Tomi