[PATCH 7/7] doc/INSTALL: Remove rst2man reference and other updates
authorW. Trevor King <wking@tremily.us>
Sat, 5 Apr 2014 17:31:11 +0000 (10:31 +1700)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:01:15 +0000 (10:01 -0800)
b2/59c8bd36a49cddaa77517d484f157c1a320966 [new file with mode: 0644]

diff --git a/b2/59c8bd36a49cddaa77517d484f157c1a320966 b/b2/59c8bd36a49cddaa77517d484f157c1a320966
new file mode 100644 (file)
index 0000000..a7fc702
--- /dev/null
@@ -0,0 +1,142 @@
+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 84F20431FAE\r
+       for <notmuch@notmuchmail.org>; Sat,  5 Apr 2014 10:31:49 -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 xqXxD9ajZEbf for <notmuch@notmuchmail.org>;\r
+       Sat,  5 Apr 2014 10:31:43 -0700 (PDT)\r
+Received: from qmta06.westchester.pa.mail.comcast.net\r
+       (qmta06.westchester.pa.mail.comcast.net [76.96.62.56])\r
+       by olra.theworths.org (Postfix) with ESMTP id 33B4D431FC3\r
+       for <notmuch@notmuchmail.org>; Sat,  5 Apr 2014 10:31:29 -0700 (PDT)\r
+Received: from omta15.westchester.pa.mail.comcast.net ([76.96.62.87])\r
+       by qmta06.westchester.pa.mail.comcast.net with comcast\r
+       id mHGf1n0061swQuc56HXUeP; Sat, 05 Apr 2014 17:31:28 +0000\r
+Received: from odin.tremily.us ([24.18.63.50])\r
+       by omta15.westchester.pa.mail.comcast.net with comcast\r
+       id mHXT1n010152l3L3bHXUeu; Sat, 05 Apr 2014 17:31:28 +0000\r
+Received: from mjolnir.tremily.us (unknown [192.168.0.140])\r
+       by odin.tremily.us (Postfix) with ESMTPS id 87F921103C1F;\r
+       Sat,  5 Apr 2014 10:31:27 -0700 (PDT)\r
+Received: (nullmailer pid 16926 invoked by uid 1000);\r
+       Sat, 05 Apr 2014 17:31:16 -0000\r
+From: "W. Trevor King" <wking@tremily.us>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 7/7] doc/INSTALL: Remove rst2man reference and other updates\r
+Date: Sat,  5 Apr 2014 10:31:11 -0700\r
+Message-Id:\r
+ <edf9a674bc1f41917caead8d38b5f09295a9d1bd.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=1396719088;\r
+       bh=Md1lXhCOAAM7U0DXVtjgsDLZgIqNFseI7EmJUDR5LR8=;\r
+       h=Received:Received:Received:Received:From:To:Subject:Date:\r
+       Message-Id;\r
+       b=uudER3SFvCG/HBEAOC1f+Jlu2qAyN4rO2Af0sfxAAJNtJTGBZI0YzMwVP1Sx889yS\r
+       1aX4JMfNpGfUSXbCR0tQV7TWsUIqGiTi583MIEo9rv/A/p0scG1BbORku3QzBb9zfj\r
+       zTOtFYlsdEQ9+dhIJvi//shOXDU92r8AVKYbxx8CHTDidptExAua16cmUbJo5rCTu+\r
+       MsRPRCkRKzOjOD/F+FSKNxDn/Rzz+MXZ4BfL7kUVvspL8vH+v7Rs773dVYJ+zQ6unQ\r
+       2tTaCJJ9JVtmF9kKEb61y9MGG4L0ufkRHcFrYK75QAaDVH0XJfZ/t4POPqWiIgta3u\r
+       yzZ1zPpYXSVtA==\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:49 -0000\r
+\r
+The rst2man target was removed in 9d9a700 (doc: build man pages at\r
+build time; introduce HAVE_SPHINX, HAVE_RST2MAN, 2014-03-13), but a\r
+reference in the install docs slipped through.  While I was removing\r
+that reference, I also:\r
+\r
+* Converted doc/INSTALL to reStructuredText, so I can link to Sphinx\r
+  and Docutils directly.  Not everyone has access to Debian's\r
+  python-docutils, so it's better to be genric here.\r
+* Converted from an unordered list to paragraphs, because I think it\r
+  flows better.\r
+* Dropped the rst2man no-automatic-install caveat.  I don't think this\r
+  applies to the current code, although I haven't tried to track down\r
+  a commit that adds the automatic-install support.  Anyhow,\r
+\r
+    $ make HAVE_SPHINX=0 RST2MAN=/usr/bin/rst2man.py DESTDIR=/tmp/ install-man\r
+\r
+  works for me.\r
+---\r
+ doc/INSTALL | 34 ++++++++++++++++++++--------------\r
+ 1 file changed, 20 insertions(+), 14 deletions(-)\r
+\r
+diff --git a/doc/INSTALL b/doc/INSTALL\r
+index e37c2b9..91222f9 100644\r
+--- a/doc/INSTALL\r
++++ b/doc/INSTALL\r
+@@ -1,24 +1,30 @@\r
+ This file contains some more detailed information about building and\r
+ installing the documentation.\r
\r
+-Building with sphinx.\r
+----------------------\r
++Building with Sphinx\r
++--------------------\r
\r
+-- You need sphinx at least version 1.0.\r
++With Sphinx_ version 1.0 or greater, you can build man, info, html,\r
++and pdf versions of the docs (currently only the man pages) with::\r
\r
+-- You can build build and install man pages with 'make install-man'\r
++  make build-{man|info|html|pdf}\r
\r
+-- You can build man, info, html, and pdf versions of the docs\r
+-  (currently only the man pages) with\r
++You can build build and install the docs (currently only the man\r
++pages) with::\r
\r
+-     'make install-{man|info|html|pdf}'\r
++  make install-{man|info|html|pdf}\r
\r
+-Building the man pages\r
+-----------------------\r
++Building the man Docutils\r
++-------------------------\r
\r
+-- You can build the man pages with rst2man (from python-docutils) with\r
+-  'make rst2man'.\r
++If you don't have Sphinx installed, you can still build the man-page\r
++version of the docs using rst2man (from Docutils_)::\r
\r
+-- Currently there is no support to automagically install the resulting\r
+-  nroff files, but it should work to modify the target install-man\r
+-  in doc/Makefile.local.\r
++  make build-man\r
++\r
++and install with::\r
++\r
++  make install-man\r
++\r
++.. _Sphinx: http://sphinx-doc.org/\r
++.. _Docutils: http://docutils.sourceforge.net/\r
+-- \r
+1.9.1.353.gc66d89d\r
+\r