Re: [PATCH 0/2] library reference man page
authorTomi Ollila <tomi.ollila@iki.fi>
Wed, 1 Jan 2014 14:15:55 +0000 (16:15 +0200)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:58:49 +0000 (09:58 -0800)
0b/5e99ac1a73300e7afc36cdbf9765a8ee819e2a [new file with mode: 0644]

diff --git a/0b/5e99ac1a73300e7afc36cdbf9765a8ee819e2a b/0b/5e99ac1a73300e7afc36cdbf9765a8ee819e2a
new file mode 100644 (file)
index 0000000..6019eb0
--- /dev/null
@@ -0,0 +1,90 @@
+Return-Path: <tomi.ollila@iki.fi>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id C6E40431FC0\r
+       for <notmuch@notmuchmail.org>; Wed,  1 Jan 2014 06:16:10 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id Az01wVNNV8VG for <notmuch@notmuchmail.org>;\r
+       Wed,  1 Jan 2014 06:16:04 -0800 (PST)\r
+Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
+       by olra.theworths.org (Postfix) with ESMTP id 839C4431FAF\r
+       for <notmuch@notmuchmail.org>; Wed,  1 Jan 2014 06:16:04 -0800 (PST)\r
+Received: from guru.guru-group.fi (localhost [IPv6:::1])\r
+       by guru.guru-group.fi (Postfix) with ESMTP id 639B81000B2;\r
+       Wed,  1 Jan 2014 16:15:56 +0200 (EET)\r
+From: Tomi Ollila <tomi.ollila@iki.fi>\r
+To: Jani Nikula <jani@nikula.org>, David Bremner <david@tethera.net>,\r
+       notmuch@notmuchmail.org\r
+Subject: Re: [PATCH 0/2] library reference man page\r
+In-Reply-To: <87r49xshd4.fsf@nikula.org>\r
+References: <cover.1385826040.git.jani@nikula.org>\r
+       <87haat4pws.fsf@zancas.localnet> <87r49xshd4.fsf@nikula.org>\r
+User-Agent: Notmuch/0.17+13~gdfcf116 (http://notmuchmail.org) Emacs/24.3.1\r
+       (x86_64-unknown-linux-gnu)\r
+X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL\r
+       $[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F\r
+       !)g;OY^,BjTbr)Np:%c_o'jj,Z\r
+Date: Wed, 01 Jan 2014 16:15:55 +0200\r
+Message-ID: <m261q3pz38.fsf@guru.guru-group.fi>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Wed, 01 Jan 2014 14:16:10 -0000\r
+\r
+On Sat, Nov 30 2013, Jani Nikula <jani@nikula.org> wrote:\r
+\r
+> On Sat, 30 Nov 2013, David Bremner <david@tethera.net> wrote:\r
+>> Jani Nikula <jani@nikula.org> writes:\r
+>>>\r
+>>>  devel/doxygen.cfg | 1890 +++++++++++++++++++++++++++++++++++++++++++++++++++++\r
+>>>  lib/notmuch.h     |  436 ++++++++----\r
+>>\r
+>> A 2K line config file is kindof gross, but other than that, I think the\r
+>> idea has merit. Do we really need that much configuration info?\r
+>\r
+> The config file is basically a template generated with 'doxygen -g' and\r
+> adjusted to our needs. It could be significantly reduced by dropping\r
+> comments, defaults, and unused settings. Maybe that would be the right\r
+> thing to do, even if the comments and defaults that are set explicitly\r
+> serve as documentation.\r
+>\r
+>> Perhaps a quibble, but at least for me the summary part of the resulting\r
+>> manpage is almost unreadable because of the amount of underlining.\r
+>\r
+> Agreed, it's not optimal. I was hoping someone more experienced with\r
+> doxygen would fix that after I shared this initial work. ;)\r
+\r
+$ doxygen -g -s\r
+...\r
+$ wc Doxyfile\r
+  305   861 10677 Doxyfile\r
+\r
+;)\r
+\r
+Maybe keeping the defaults is better than hassle with just the changed\r
+options ?\r
+\r
+\r
+> BR,\r
+> Jani.\r
+\r
+Tomi\r