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