[PATCH 5/7] doc: Allow rst2man.py as an alternative to rst2man
authorW. Trevor King <wking@tremily.us>
Sat, 5 Apr 2014 17:31:09 +0000 (10:31 +1700)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:01:15 +0000 (10:01 -0800)
83/01e79069ed0cf5ae7a5f8242a183b637554746 [new file with mode: 0644]

diff --git a/83/01e79069ed0cf5ae7a5f8242a183b637554746 b/83/01e79069ed0cf5ae7a5f8242a183b637554746
new file mode 100644 (file)
index 0000000..da13995
--- /dev/null
@@ -0,0 +1,182 @@
+Return-Path: <wking@tremily.us>\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 82EB7431FAE\r
+       for <notmuch@notmuchmail.org>; Sat,  5 Apr 2014 10:31:43 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References"\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\r
+       tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001]\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 CPkyIqB19YhS for <notmuch@notmuchmail.org>;\r
+       Sat,  5 Apr 2014 10:31:37 -0700 (PDT)\r
+Received: from qmta15.westchester.pa.mail.comcast.net\r
+       (qmta15.westchester.pa.mail.comcast.net [76.96.59.228])\r
+       by olra.theworths.org (Postfix) with ESMTP id 268F9431FC0\r
+       for <notmuch@notmuchmail.org>; Sat,  5 Apr 2014 10:31:28 -0700 (PDT)\r
+Received: from omta10.westchester.pa.mail.comcast.net ([76.96.62.28])\r
+       by qmta15.westchester.pa.mail.comcast.net with comcast\r
+       id mFuc1n0020cZkys5FHXT2B; Sat, 05 Apr 2014 17:31:27 +0000\r
+Received: from odin.tremily.us ([24.18.63.50])\r
+       by omta10.westchester.pa.mail.comcast.net with comcast\r
+       id mHXS1n00N152l3L3WHXTZw; Sat, 05 Apr 2014 17:31:27 +0000\r
+Received: from mjolnir.tremily.us (unknown [192.168.0.140])\r
+       by odin.tremily.us (Postfix) with ESMTPS id 67EFB1103C1B;\r
+       Sat,  5 Apr 2014 10:31:26 -0700 (PDT)\r
+Received: (nullmailer pid 16921 invoked by uid 1000);\r
+       Sat, 05 Apr 2014 17:31:15 -0000\r
+From: "W. Trevor King" <wking@tremily.us>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 5/7] doc: Allow rst2man.py as an alternative to rst2man\r
+Date: Sat,  5 Apr 2014 10:31:09 -0700\r
+Message-Id:\r
+ <adce76bb9a0ca728d856da4ecaf6b282e22e7440.1396718720.git.wking@tremily.us>\r
+X-Mailer: git-send-email 1.9.1.353.gc66d89d\r
+In-Reply-To: <cover.1396718720.git.wking@tremily.us>\r
+References: <cover.1396718720.git.wking@tremily.us>\r
+In-Reply-To: <cover.1396718720.git.wking@tremily.us>\r
+References: <cover.1396718720.git.wking@tremily.us>\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=comcast.net;\r
+       s=q20140121; t=1396719087;\r
+       bh=pA1t9ChZWMir5BXJfljawrzzmFw6nHncXINLUCSvNgQ=;\r
+       h=Received:Received:Received:Received:From:To:Subject:Date:\r
+       Message-Id;\r
+       b=hTcNmrNp6jktDN9LsPcPm93PaD87H2X+YtHXkCXDIo6uIy1JsHFhZvteKKzX20e4y\r
+       5I6z2K/xaBsCteQQIRwmLemXXMSsfdRKh8BjlUISNZAuy3opSVhXSck0AtNwRicRB5\r
+       3eLtbqeYmBIgrps6gDOkyvQ9d7316a3SC4HfnNf9B7Prw+2o2jUdbZ2yTPJ0UriXEK\r
+       yFWWs6oIjYB6TQo5/p3gKrE05Fs0pi0U+E6uJcI1L1/V83KXBu5Y9b/AmnW214twel\r
+       wiA3AEY48tY3Lu3mzaDuGbkLjfAa7qR9hQ8zz0pCc0nlWYMdAcF3lJwzA+Hocu6bgO\r
+       Zwhnl2T5CkLfg==\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, 05 Apr 2014 17:31:43 -0000\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.  We can use a\r
+non-empty RST2MAN to check for the availability of an rst2man program,\r
+so there's no need for a separate HAVE_RST2MAN.  Then pass the\r
+configured RST2MAN path through to prerst2man.py to use in its system\r
+call.\r
+\r
+[1]: http://pubs.opengroup.org/onlinepubs/9699919799/utilities/command.html\r
+---\r
+ configure          | 12 +++++++-----\r
+ doc/Makefile.local |  6 +++---\r
+ doc/prerst2man.py  |  9 +++++----\r
+ 3 files changed, 15 insertions(+), 12 deletions(-)\r
+\r
+diff --git a/configure b/configure\r
+index 1d430b9..81c286b 100755\r
+--- a/configure\r
++++ b/configure\r
+@@ -400,7 +400,6 @@ printf "Checking if sphinx is available and supports nroff output... "\r
+ if hash sphinx-build > /dev/null 2>&1 && python -m sphinx.writers.manpage > /dev/null 2>&1 ; then\r
+     printf "Yes.\n"\r
+     have_sphinx=1\r
+-    have_rst2man=0\r
+ else\r
+     printf "No (falling back to rst2man).\n"\r
+     have_sphinx=0\r
+@@ -408,10 +407,12 @@ else\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
++    elif rst2man.py -V > /dev/null 2>&1; then\r
++       printf "Yes.\n"\r
++       RST2MAN=$(command -v rst2man.py)\r
+     else\r
+        printf "No (so will not install man pages).\n"\r
+-       have_rst2man=0\r
+     fi\r
+ fi\r
\r
+@@ -788,8 +789,9 @@ HAVE_EMACS = ${have_emacs}\r
+ # Whether there's a sphinx-build binary available for building documentation\r
+ HAVE_SPHINX=${have_sphinx}\r
\r
+-# Whether there's a rst2man binary available for building documentation\r
+-HAVE_RST2MAN=${have_rst2man}\r
++# The path to the rst2man program for building documentation.  Set to\r
++# an empty string if no such program is available.\r
++RST2MAN=${RST2MAN}\r
\r
+ # The directory to which desktop files should be installed\r
+ desktop_dir = \$(prefix)/share/applications\r
+diff --git a/doc/Makefile.local b/doc/Makefile.local\r
+index 0980c71..e08fc99 100644\r
+--- a/doc/Makefile.local\r
++++ b/doc/Makefile.local\r
+@@ -42,8 +42,8 @@ ifeq ($(HAVE_SPHINX),1)\r
+           mkdir -p $(DOCBUILDDIR)/man/man$${section}; \\r
+           mv $(DOCBUILDDIR)/man/*.$${section} $(DOCBUILDDIR)/man/man$${section}; \\r
+       done\r
+-else ifeq ($(HAVE_RST2MAN),1)\r
+-      $(prerst2man) $(srcdir)/doc $(DOCBUILDDIR)/man\r
++else ifdef RST2MAN\r
++      $(prerst2man) "$(RST2MAN)" $(srcdir)/doc $(DOCBUILDDIR)/man\r
+ else\r
+       @echo "Fatal: build dependency fail."\r
+       @false\r
+@@ -51,7 +51,7 @@ endif\r
\r
+ # Do not try to build or install man pages if a man page converter is\r
+ # not available.\r
+-ifeq ($(HAVE_SPHINX)$(HAVE_RST2MAN),00)\r
++ifeq ($(HAVE_SPHINX)$(RST2MAN),0)\r
+ build-man:\r
+ install-man:\r
+       @echo "No sphinx or rst2man, will not install man pages."\r
+diff --git a/doc/prerst2man.py b/doc/prerst2man.py\r
+index 437dea9..81ce817 100644\r
+--- a/doc/prerst2man.py\r
++++ b/doc/prerst2man.py\r
+@@ -4,8 +4,9 @@ from os.path import dirname, isdir\r
+ from os import makedirs, system\r
+ import re\r
\r
+-sourcedir = argv[1]\r
+-outdir = argv[2]\r
++rst2man = argv[1]\r
++sourcedir = argv[2]\r
++outdir = argv[3]\r
\r
+ if not isdir(outdir):\r
+     makedirs(outdir, 0o755)\r
+@@ -59,5 +60,5 @@ for page in man_pages:\r
+     outfile.write("".join(lines))\r
+     outfile.close()\r
\r
+-    system('set -x; rst2man {0} {1}/{2}.{3}'\r
+-           .format(filename, outdir, page[0], page[4]))\r
++    system('set -x; {0} {1} {2}/{3}.{4}'\r
++           .format(rst2man, filename, outdir, page[0], page[4]))\r
+-- \r
+1.9.1.353.gc66d89d\r
+\r