[PATCH 0/2] library reference man page

diff --git a/0e/bf9a07bb5a9faf7cf7c4a01a604bf85856dffb b/0e/bf9a07bb5a9faf7cf7c4a01a604bf85856dffb
new file mode 100644 (file)
index 0000000..0ea83eb
--- /dev/null
+++ b/0e/bf9a07bb5a9faf7cf7c4a01a604bf85856dffb
@@ -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 B3FA3431FC9\r
+       for <notmuch@notmuchmail.org>; Sat, 30 Nov 2013 07:43:05 -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 V3CGrwXr6OHN for <notmuch@notmuchmail.org>;\r
+       Sat, 30 Nov 2013 07:42:58 -0800 (PST)\r
+Received: from mail-lb0-f179.google.com (mail-lb0-f179.google.com\r
+       [209.85.217.179]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 85AB3431FAF\r
+       for <notmuch@notmuchmail.org>; Sat, 30 Nov 2013 07:42:58 -0800 (PST)\r
+Received: by mail-lb0-f179.google.com with SMTP id l4so7757531lbv.10\r
+       for <notmuch@notmuchmail.org>; Sat, 30 Nov 2013 07:42:57 -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=v/qsVbvhuiAFb5a/LRqCc7oZkF3ao1yhgpomcoH08Vw=;\r
+       b=W05d/FuZra/+7TB9ky/r+OvvhbVm22lxJVdXpvrZ62QROb0CSD8NdA32/XbGX4hQzP\r
+       jpzw0CGeC+W6hMtf+4J3Cebip0OEKxrAXHRW48XfadT1ld4j6vZew6/VzJxDIyY9JhVK\r
+       BJZbhdR03sQEnfVvpLGF4acJYAcQoXhPRCiomu3UEc5jLGU48JhJ7DH6J6Riq/MuXc+z\r
+       FOomBnNP1yrFFzJCSqnA+4tlN1X7TtAJW8rRZmYagPMI4hZDtoEHaALPD1b+WAOejXDY\r
+       5/Qspa5tk6SmpLyCr8EriMHDWCfScYkvq875CRAP0DGunaP2UTly/ETGnFhPRlN1ltl8\r
+       kqRw==\r
+X-Gm-Message-State:\r
+ ALoCoQmsDyKY/PTnxSMmPUgaVvXZ4HlUpVPUmytU2ucPD0GLzrBTf3o9n1TWboUAitBJNdhy2Bqq\r
+X-Received: by 10.152.7.67 with SMTP id h3mr115524laa.29.1385826177059;\r
+       Sat, 30 Nov 2013 07:42:57 -0800 (PST)\r
+Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi.\r
+       [88.195.111.91]) by mx.google.com with ESMTPSA id\r
+       sd11sm69220949lab.2.2013.11.30.07.42.55 for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Sat, 30 Nov 2013 07:42:56 -0800 (PST)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 0/2] library reference man page\r
+Date: Sat, 30 Nov 2013 17:42:50 +0200\r
+Message-Id: <cover.1385826040.git.jani@nikula.org>\r
+X-Mailer: git-send-email 1.8.4.2\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: Sat, 30 Nov 2013 15:43:05 -0000\r
+\r
+v1 after RFC at id:cover.1383758666.git.jani@nikula.org.\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
+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     |  436 ++++++++----\r
+ 2 files changed, 2186 insertions(+), 140 deletions(-)\r
+ create mode 100644 devel/doxygen.cfg\r
+\r
+-- \r
+1.8.4.2\r
+\r