Date: Thu, 31 Dec 2015 12:28:15 -0800
From: "W. Trevor King" <wking@tremily.us>
To: David Bremner <david@tethera.net>
Cc: Jani Nikula <jani@nikula.org>, notmuch@notmuchmail.org
Subject: Re: [PATCH 3/5] nmbug-status: Add an nmbug-status(5) man page
Message-ID: <20151231202815.GL3680@odin.tremily.us>
References: <cover.1451502495.git.wking@tremily.us>
 <0a1bd306cb2e306ff49d72b6d2466c1d4a0ade2b.1451502495.git.wking@tremily.us>
 <87ege26fi4.fsf@nikula.org> <87fuyi4iwm.fsf@zancas.localnet>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha1;
 protocol="application/pgp-signature"; boundary="0qVF/w3MHQqLSynd"
Content-Disposition: inline
In-Reply-To: <87fuyi4iwm.fsf@zancas.localnet>
OpenPGP: id=39A2F3FA2AB17E5D8764F388FC29BDCDF15F5BE8;
 url=http://tremily.us/pubkey.txt
User-Agent: Mutt/1.5.23 (2014-03-12)
Precedence: list


--0qVF/w3MHQqLSynd
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Thu, Dec 31, 2015 at 01:39:21PM -0400, David Bremner wrote:
> Jani Nikula writes:
> > 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.

Yeah, a man page about the tool itself would be good.  If I add one,
we'd have a situation like procmail(1) and procmailrc(5).  One
difficulty for naming the config-file-format man page is that
status-config.json is not a particularly specific name.  If we're
renaming the tools anyway, I'd suggest we just go with
${EVENTUAL_NMBUG_STATUS_NAME}.json for the default config filename and
man page.

> 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?

Sounds good to me.  And Gentoo has installed it (if you've set the
=E2=80=98nmbug=E2=80=99 USE flag [1]) since 0.11.1-r1, 2012-02-21 [2].  I'm=
 not sure
what the new names should be.  nmbug =E2=86=92 notmuch-dtag (for distributed
tag) and nmbug-status =E2=86=92 notmuch-report?

> That would have to be somehow tied to installing the python
> bindings;

On Gentoo, that happens via REQUIRED_USE [3,4].  An alternative for
packaging systems without USE-flag-style flexibility would be to spin
them off into a separate project that depends on Git and notmuch's
Python bindings.

Cheers,
Trevor

[1]: https://gitweb.gentoo.org/repo/gentoo.git/tree/net-mail/notmuch/metada=
ta.xml
[2]: https://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo-x86/net-mail/notm=
uch/ChangeLog?hideattic=3D0&revision=3D1.23&view=3Dmarkup
[3]: https://gitweb.gentoo.org/repo/gentoo.git/tree/net-mail/notmuch/notmuc=
h-0.21.ebuild?id=3D45ba77ab1dee61a2590c9f4903e620c5cf4d5f68#n23
[4]: https://projects.gentoo.org/pms/6/pms.html#x1-890008.2.7

--=20
This email may be signed or encrypted with GnuPG (http://www.gnupg.org).
For more information, see http://en.wikipedia.org/wiki/Pretty_Good_Privacy

--0qVF/w3MHQqLSynd
Content-Type: application/pgp-signature; name="signature.asc"
Content-Description: OpenPGP digital signature

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iQIcBAEBAgAGBQJWhY/cAAoJEAPqygegUbGsyvUQAId/Noszvtwx3dFn1qvqSXAH
/hMBL8QcihLG1CSVyWDY4v5MhLIaVnfwmorXX0FoEni6Evp2V3WCICmAAb1CTAcJ
8bjhUmb4Jw+GqJEfyk4c/GNUAG54z60bngR1QnlPzN+4a81v+ZHgucbdxZhp1a7h
xk4al6eiZeMIXkSmkZ/80xQ7ffwRRsAjx4CGZqkuB4vp145gcLin7d/dSCx1wSxf
O5ePNPmEQRRw0lVToqbHmg42Npc9WA4Ld7bhIULIOebvYSGRZQq+I+oEOtoXfE1l
nqo78prm7AeyZHKQcQmSuFIAqdwUWKXfxHsxo+iXGt3m5KkbLAXv4xErCCM2R+Bh
woEioJaZmP99HlZ7LYWtUwC0ssRme5DdsmaFwLMeb0/d94A1+tYJL8kxF8PCBZRY
Ovmr0gTrBBOQ+YfQaArFifCEwUdbla5jbkepkisHsBmw/8MTQ01zF8rEJMiETaLk
tb/vUvvQ/TWPYfIE37KU0rObIjAJ2RR59rAXC7a+JouhzycRjh90jjW7ktBLvs5/
1uGnl9cP0q8JhTw3AOtPMeriVHkkPMW2ZBjUYmGrYTvZdJiTdG1AUXIL914zSo+X
AUu41T9TJaAjXwqcjrenYygRWFhn5nsv9i2B81IxL/XUHq+MgIw45fLLizrZQ8iG
qN259+xq7XuRDgIXkExY
=dUcr
-----END PGP SIGNATURE-----

--0qVF/w3MHQqLSynd--