[RFC PATCH 0/2] library reference man page

diff --git a/63/a4a51e3263ffa59e34e73cbcf2eed2ebe23274 b/63/a4a51e3263ffa59e34e73cbcf2eed2ebe23274
new file mode 100644 (file)
index 0000000..cc52f4d
--- /dev/null
+++ b/63/a4a51e3263ffa59e34e73cbcf2eed2ebe23274
@@ -0,0 +1,100 @@
+Return-Path: <jani@nikula.org>\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 9DCC7429E59\r
+       for <notmuch@notmuchmail.org>; Wed,  6 Nov 2013 10:01:30 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7] 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 Mb4dW23dVwux for <notmuch@notmuchmail.org>;\r
+       Wed,  6 Nov 2013 10:01:23 -0800 (PST)\r
+Received: from mail-ea0-f178.google.com (mail-ea0-f178.google.com\r
+       [209.85.215.178]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id E206E429E53\r
+       for <notmuch@notmuchmail.org>; Wed,  6 Nov 2013 10:01:22 -0800 (PST)\r
+Received: by mail-ea0-f178.google.com with SMTP id a10so1968374eae.23\r
+       for <notmuch@notmuchmail.org>; Wed, 06 Nov 2013 10:01:21 -0800 (PST)\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+       d=1e100.net; s=20130820;\r
+       h=x-gm-message-state:from:to:cc:subject:date:message-id;\r
+       bh=uMjV3hGG2SXO7kDiehfnoxtKmSxIV0ffp5V7FfBJzJI=;\r
+       b=VGdWVZvuip8S/i3HpQVTdgV/4lgAWilNfM6u6/dvsoGN571KyqQITH650GqYo9BirS\r
+       GncD9Bwj0CnRoqZz4NZLhUqVSjO0Yzbwv4vtrhsCEFf7G3yyIFgxbGOsVOYY4sopgnjK\r
+       KrrC6/kuPBwY+tpkMQW8f8v1+fvx8sqTkYZvAzt9tvFvQgrb4KYjPcz2cOMbVM0/Dl7J\r
+       APWd1z3eGxqmItRvw6nl9HCulODABmIIhop0dWY9FmPL/p4//5hc1lAy2K9K7rXLESCs\r
+       sZK/x/vxucQ837e2k+HUe2Lps5IuJDluzI/AYLPFRDEbU5/s8/S2gJOcV/r2So7UliIZ\r
+       wDZg==\r
+X-Gm-Message-State:\r
+ ALoCoQmRLieQeiCQL8a7nXbXWQG/B1Br5fcSwdcqCHclBe8ni3IFzN2kwc796fq/gtdARbBRRWcF\r
+X-Received: by 10.15.73.130 with SMTP id h2mr4872316eey.56.1383759344799;\r
+       Wed, 06 Nov 2013 09:35:44 -0800 (PST)\r
+Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi.\r
+       [88.195.111.91])\r
+       by mx.google.com with ESMTPSA id b42sm76321235eem.9.2013.11.06.09.35.42\r
+       for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Wed, 06 Nov 2013 09:35:43 -0800 (PST)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: notmuch@notmuchmail.org\r
+Subject: [RFC PATCH 0/2] library reference man page\r
+Date: Wed,  6 Nov 2013 19:35:39 +0200\r
+Message-Id: <cover.1383758666.git.jani@nikula.org>\r
+X-Mailer: git-send-email 1.8.4.rc3\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, 06 Nov 2013 18:01:30 -0000\r
+\r
+These two patches add a doxygen configuration file and minimal changes\r
+to lib/notmuch.h to produce man/man3/notmuch.3 library reference.\r
+\r
+Apply patches, and run\r
+ $ doxygen devel/doxygen.cfg\r
+ $ man man/man3/notmuch.3\r
+\r
+There's still plenty to do, but perhaps we could get started with\r
+merging this? There's no harm done, and would help collaboration on\r
+this.\r
+\r
+TODO:\r
+\r
+* make this part of the build/install process\r
+* check version in release checks\r
+* figure out how to *not* create a file list man page\r
+* upload the man page to the web site\r
+* generate html pages too, and upload to web site also\r
+* start using doxygen/javadoc tags to produce nicer output\r
+\r
+\r
+Cheers,\r
+Jani.\r
+\r
+\r
+Jani Nikula (2):\r
+  devel: add doxygen configuration file\r
+  lib: modify notmuch.h for automatic document generation\r
+\r
+ devel/doxygen.cfg | 1890 +++++++++++++++++++++++++++++++++++++++++++++++++++++\r
+ lib/notmuch.h     |  426 ++++++++----\r
+ 2 files changed, 2179 insertions(+), 137 deletions(-)\r
+ create mode 100644 devel/doxygen.cfg\r
+\r
+-- \r
+1.8.4.rc3\r
+\r