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

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

Date: Thu, 31 Dec 2015 13:39:21 -0400

To: Jani Nikula, W. Trevor King, notmuch@notmuchmail.org

Cc:

From: David Bremner


Jani Nikula <jani@nikula.org> writes:

> On Wed, 30 Dec 2015, "W. Trevor King" <wking@tremily.us> 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.

d

Thread: