Re: [PATCH 5/7] doc: Allow rst2man.py as an alternative to rst2man
authorTomi Ollila <tomi.ollila@iki.fi>
Sun, 6 Apr 2014 08:37:09 +0000 (11:37 +0300)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:01:21 +0000 (10:01 -0800)
a8/4b9e769bfe63f1cbf69dddd3cd37b178ac368f [new file with mode: 0644]

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