Re: [PATCH v2 1/5] doc: Allow rst2man.py as an alternative to rst2man
authorTomi Ollila <tomi.ollila@iki.fi>
Sat, 12 Jul 2014 08:00:52 +0000 (11:00 +0300)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:03:30 +0000 (10:03 -0800)
0c/6c06b88d875c190e7a51392c3ccd866f035bcf [new file with mode: 0644]

diff --git a/0c/6c06b88d875c190e7a51392c3ccd866f035bcf b/0c/6c06b88d875c190e7a51392c3ccd866f035bcf
new file mode 100644 (file)
index 0000000..f3620c8
--- /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 36490431FBD\r
+       for <notmuch@notmuchmail.org>; Sat, 12 Jul 2014 01:01:04 -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 Qj0PQvcKcCyS for <notmuch@notmuchmail.org>;\r
+       Sat, 12 Jul 2014 01:01:00 -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 A4521431FBC\r
+       for <notmuch@notmuchmail.org>; Sat, 12 Jul 2014 01:01:00 -0700 (PDT)\r
+Received: from guru.guru-group.fi (localhost [IPv6:::1])\r
+       by guru.guru-group.fi (Postfix) with ESMTP id A6FAC10008F;\r
+       Sat, 12 Jul 2014 11:00:52 +0300 (EEST)\r
+From: Tomi Ollila <tomi.ollila@iki.fi>\r
+To: "W. Trevor King" <wking@tremily.us>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH v2 1/5] doc: Allow rst2man.py as an alternative to rst2man\r
+In-Reply-To:\r
+ <c8b019cf95243e4b47780a19d0bfca5b65c79ecb.1399740604.git.wking@tremily.us>\r
+References: <cover.1399740604.git.wking@tremily.us>\r
+       <c8b019cf95243e4b47780a19d0bfca5b65c79ecb.1399740604.git.wking@tremily.us>\r
+User-Agent: Notmuch/0.18.1+25~gdaf4b6f (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: Sat, 12 Jul 2014 11:00:52 +0300\r
+Message-ID: <m2ion3dn0r.fsf@guru.guru-group.fi>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain\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: Sat, 12 Jul 2014 08:01:04 -0000\r
+\r
+On Sat, May 10 2014, "W. Trevor King" <wking@tremily.us> wrote:\r
+\r
+> Gentoo's dev-python/docutils-0.10 installs Docutils scripts with a\r
+> *.py extension, so I have /usr/bin/rst2man.py and no rst2man script.\r
+> This patch supports users with both types of systems by checking for\r
+> rst2man, falling back on rst2man.py, and giving up only if neither is\r
+> found.  Users can also set the new RST2MAN path variable explicitly\r
+> when they call Make:\r
+>\r
+>   make RST2MAN=/my/custom/rst_to_man_converter build-man\r
+>\r
+> I use POSIX's 'command -v' [1] to find the path to rst2man or\r
+> rst2man.py, and save that as RST2MAN in Makefile.config.  Then pass\r
+> the configured RST2MAN path through to prerst2man.py to use in its\r
+> system call.\r
+\r
+The comment block above can be removed if the change I suggest below will\r
+be done...\r
+\r
+>\r
+> We can use a non-empty RST2MAN to check for the availability of an\r
+> rst2man program, so there's no need for a separate HAVE_RST2MAN.\r
+> However, we keep the existing HAVE_RST2MAN for consistency with\r
+> HAVE_SPHINX.\r
+>\r
+> [1]: http://pubs.opengroup.org/onlinepubs/9699919799/utilities/command.html\r
+\r
+ditto\r
+\r
+> ---\r
+>  configure          | 15 +++++++++++++--\r
+>  doc/Makefile.local |  2 +-\r
+>  doc/prerst2man.py  |  9 +++++----\r
+>  3 files changed, 19 insertions(+), 7 deletions(-)\r
+>\r
+> diff --git a/configure b/configure\r
+> index 9bde2eb..f017af8 100755\r
+> --- a/configure\r
+> +++ b/configure\r
+> @@ -413,17 +413,24 @@ if hash sphinx-build > /dev/null 2>&1 && python -m sphinx.writers.manpage > /dev\r
+>      printf "Yes.\n"\r
+>      have_sphinx=1\r
+>      have_rst2man=0\r
+> +    RST2MAN=\r
+>  else\r
+>      printf "No (falling back to rst2man).\n"\r
+>      have_sphinx=0\r
+>  \r
+>      printf "Checking if rst2man is available... "\r
+>      if rst2man -V > /dev/null 2>&1; then\r
+> -       printf "Yes.\n"\r
+>         have_rst2man=1\r
+> +       RST2MAN=$(command -v rst2man)\r
+\r
+This could be just RST2MAN=rst2man -- for consistency -- otherwise we'd\r
+need to give the same treatment to all other commands we check...\r
+\r
+\r
+> +       printf "Yes (${RST2MAN}).\n"\r
+> +    elif rst2man.py -V > /dev/null 2>&1; then\r
+> +       have_rst2man=1\r
+> +       RST2MAN=$(command -v rst2man.py)\r
+\r
+Ditto, RST2MAN=rst2man.py\r
+\r
+\r
+> +       printf "Yes (${RST2MAN}).\n"\r
+>      else\r
+> -       printf "No (so will not install man pages).\n"\r
+>         have_rst2man=0\r
+> +       RST2MAN=\r
+> +       printf "No (so will not install man pages).\n"\r
+>      fi\r
+>  fi\r
+\r
+Tomi\r