From: Tomi Ollila Date: Sun, 6 Apr 2014 08:37:09 +0000 (+0300) Subject: Re: [PATCH 5/7] doc: Allow rst2man.py as an alternative to rst2man X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=2ae7225a95d679bd2f9ab10e3919b96cc90c51b1;p=notmuch-archives.git Re: [PATCH 5/7] doc: Allow rst2man.py as an alternative to rst2man --- diff --git a/a8/4b9e769bfe63f1cbf69dddd3cd37b178ac368f b/a8/4b9e769bfe63f1cbf69dddd3cd37b178ac368f new file mode 100644 index 000000000..63da834c8 --- /dev/null +++ b/a8/4b9e769bfe63f1cbf69dddd3cd37b178ac368f @@ -0,0 +1,128 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 668B2431FB6 + for ; Sun, 6 Apr 2014 01:37:21 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: 0 +X-Spam-Level: +X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none] + autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id J+vZeTFELqkA for ; + Sun, 6 Apr 2014 01:37:14 -0700 (PDT) +Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34]) + by olra.theworths.org (Postfix) with ESMTP id D0E68431FAF + for ; Sun, 6 Apr 2014 01:37:13 -0700 (PDT) +Received: from guru.guru-group.fi (localhost [IPv6:::1]) + by guru.guru-group.fi (Postfix) with ESMTP id 71F0E100086; + Sun, 6 Apr 2014 11:37:09 +0300 (EEST) +From: Tomi Ollila +To: "W. Trevor King" +Subject: Re: [PATCH 5/7] doc: Allow rst2man.py as an alternative to rst2man +In-Reply-To: <20140405191917.GF5316@odin.tremily.us> +References: + + + <20140405191917.GF5316@odin.tremily.us> +User-Agent: Notmuch/0.17+174~gef82849 (http://notmuchmail.org) Emacs/24.3.1 + (x86_64-unknown-linux-gnu) +X-Face: HhBM'cA~ +MIME-Version: 1.0 +Content-Type: text/plain; charset=utf-8 +Content-Transfer-Encoding: quoted-printable +Cc: notmuch@notmuchmail.org +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +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: Sun, 06 Apr 2014 08:37:21 -0000 + +On Sat, Apr 05 2014, "W. Trevor King" wrote: + +> On Sat, Apr 05, 2014 at 10:05:31PM +0300, Tomi Ollila wrote: +>> On Sat, Apr 05 2014, W. Trevor King wrote: +>> > I use POSIX's 'command -v' [1] to find the path to rst2man=E2=80=A6 +>> > +>> > [1]: http://pubs.opengroup.org/onlinepubs/9699919799/utilities/command= +.html +>>=20 +>> =E2=80=A6 +>> Except the reference to _POSIX_ page. One knows how consistent these +>> specifications are; alternative: +>>=20 +>> http://pubs.opengroup.org/onlinepubs/009695399/utilities/command.html +>>=20 +>> mentions additionally that -v flag +>> "(On systems supporting the User Portability Utilities option.)"=20 +> +> It's been a decade since POSIX 2004 ;). I'm not sure when the =E2=80=9CU= +ser +> Portability Utilities=E2=80=9D caveat was removed, but I imagine most +> POSIX-aspiring shells have -v support. Short of citing POSIX 2013, I +> think I'd have to survey likely shells, and that seems even less +> reliable. Maybe I'm missunderstanding your suggested change? +> +>> Also, we don't give such a treatment to other command either; I'd rather +>> see RST2MAN=3Drst2man, RST2MAN=3Drst2man.py *and* RST2MAN=3D lines used +>> instead -- the last to set RST2MAN to empty string instead of being unse= +t. +> +> I'm fine with that. Alternatively, we could add an: +> +> if -n "${RST2MAN}" +> +> clause to the front of the detection code to allow users with oddball +> scripts (maybe a null set) to override RST2MAN at configure time: +> +> $ RST2MAN=3D/my/custom/rst_to_man_converter ./configure +> $ make +> +> instead of at make-invocation time: +> +> $ ./configure +> $ make RST2MAN=3D/my/custom/rst_to_man_converter +> +> That would consolidate configuration around the 'config' call, and +> make explicitly emptying the RST2MAN variable more clearly superfluous +> (although I'm still fine with an explicit empty). +> +> Thoughts? + +If we did that, what about other commands, starting with sphinx-build +(that is harder as python -m `sphinx.writers.manpage` fails even=20 +sphinx-build is set to something else; in case of sphinx,=20 +make SPHINXBUILD=3Dsphinx-1.0-build works, for example in RHEL 6.2=20 +machines... + +...doing --with-rst2man=3Dmy.custom.rst_to_man_converter and make things +look consistent would required considerable amount of development +(and review!) time... + +ATM I'd just settle with plain command names and empty RST2MAN in case not +found.=20 + +> +> Trevor +> +> --=20 + +More Thoughts? + + +Tomi