Re: [PATCH 3/5] nmbug-status: Add an nmbug-status(5) man page

diff --git a/cd/87bd952d5081311207918bb23776919185f23a b/cd/87bd952d5081311207918bb23776919185f23a
new file mode 100644 (file)
index 0000000..ac21e41
--- /dev/null
+++ b/cd/87bd952d5081311207918bb23776919185f23a
@@ -0,0 +1,95 @@
+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 arlo.cworth.org (Postfix) with ESMTP id 0C6E96DE1A3F\r
+ for <notmuch@notmuchmail.org>; Fri,  1 Jan 2016 03:23:29 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at cworth.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0.681\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0.681 tagged_above=-999 required=5 tests=[AWL=0.029, \r
+ SPF_NEUTRAL=0.652] autolearn=disabled\r
+Received: from arlo.cworth.org ([127.0.0.1])\r
+ by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id YWgk5nESi6Lv for <notmuch@notmuchmail.org>;\r
+ Fri,  1 Jan 2016 03:23:26 -0800 (PST)\r
+Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
+ by arlo.cworth.org (Postfix) with ESMTP id 7D8356DE1642\r
+ for <notmuch@notmuchmail.org>; Fri,  1 Jan 2016 03:23:25 -0800 (PST)\r
+Received: from guru.guru-group.fi (localhost [IPv6:::1])\r
+ by guru.guru-group.fi (Postfix) with ESMTP id D823E10008D;\r
+ Fri,  1 Jan 2016 13:23:37 +0200 (EET)\r
+From: Tomi Ollila <tomi.ollila@iki.fi>\r
+To: David Bremner <david@tethera.net>, Jani Nikula <jani@nikula.org>,\r
+ "W. Trevor King" <wking@tremily.us>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH 3/5] nmbug-status: Add an nmbug-status(5) man page\r
+In-Reply-To: <87fuyi4iwm.fsf@zancas.localnet>\r
+References: <cover.1451502495.git.wking@tremily.us>\r
+ <0a1bd306cb2e306ff49d72b6d2466c1d4a0ade2b.1451502495.git.wking@tremily.us>\r
+ <87ege26fi4.fsf@nikula.org> <87fuyi4iwm.fsf@zancas.localnet>\r
+User-Agent: Notmuch/0.21+32~g73439f8 (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: Fri, 01 Jan 2016 13:23:37 +0200\r
+Message-ID: <m2twmxbl1i.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.20\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <https://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: <https://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Fri, 01 Jan 2016 11:23:29 -0000\r
+\r
+On Thu, Dec 31 2015, David Bremner <david@tethera.net> wrote:\r
+\r
+> Jani Nikula <jani@nikula.org> writes:\r
+>\r
+>> On Wed, 30 Dec 2015, "W. Trevor King" <wking@tremily.us> wrote:\r
+>>> To describe the config file format, so folks don't have to dig through\r
+>>> NEWS or the nmbug-status source to get that information.\r
+>>\r
+>> Overall I approve of the series (though I did not do a thorough\r
+>> review).\r
+>>\r
+>> I am wondering about the man page though. I find it slightly confusing\r
+>> there would be a man page named after the tool describing just the\r
+>> config, but not the tool itself.\r
+>\r
+> For me it's a bit odd to have a man page for a tool we don't install by\r
+> default. Is it maybe time to "promote" nmbug-status to the notmuch-\r
+> namespace and install it by default? That would have to be somehow tied\r
+> to installing the python bindings; or else the script could just print a\r
+> helpful error message if the bindings are not found.\r
+>\r
+> This would also allow addressing Tomi's comment about testing, by adding\r
+> a couple of tests to the test suite.\r
+\r
+What we could simply have at the time being:\r
+\r
+  devel/nmbug/nmbug\r
+  devel/nmbug/nmbug.rst (or .1)\r
+  devel/nmbug/nmbug-status\r
+  devel/nmbug/nmbug-status.rst (or .1)\r
+  devel/nmbug/nmbug-status-config\r
+  devel/nmbug/nmbug-status-config.rst (or .5)\r
+\r
+(and if .rst:s, a Makefile to build the namual pages)\r
+\r
+The responsibility to install the tools could be\r
+outside of notmuch for now...\r
+\r
+Tomi\r
+\r
+>\r
+> d\r