Re: [PATCH 7/7] doc/INSTALL: Remove rst2man reference and other updates

diff --git a/9f/456f8d7788fcaa3cbfb0c1eef034d369b24307 b/9f/456f8d7788fcaa3cbfb0c1eef034d369b24307
new file mode 100644 (file)
index 0000000..10ecf23
--- /dev/null
+++ b/9f/456f8d7788fcaa3cbfb0c1eef034d369b24307
@@ -0,0 +1,137 @@
+Return-Path: <david@tethera.net>\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 1C8C0431FBF\r
+       for <notmuch@notmuchmail.org>; Sat,  5 Apr 2014 13:37:12 -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 cPzvoISenwEN for <notmuch@notmuchmail.org>;\r
+       Sat,  5 Apr 2014 13:37:04 -0700 (PDT)\r
+Received: from mx.xen14.node3324.gplhost.com (gitolite.debian.net\r
+       [87.98.215.224]) (using TLSv1 with cipher AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id C5897431FAF\r
+       for <notmuch@notmuchmail.org>; Sat,  5 Apr 2014 13:37:04 -0700 (PDT)\r
+Received: from remotemail by mx.xen14.node3324.gplhost.com with local (Exim\r
+       4.72) (envelope-from <david@tethera.net>)\r
+       id 1WWXJt-0000Xt-1Y; Sat, 05 Apr 2014 20:36:05 +0000\r
+Received: (nullmailer pid 11036 invoked by uid 1000); Sat, 05 Apr 2014\r
+       20:35:49 -0000\r
+From: David Bremner <david@tethera.net>\r
+To: "W. Trevor King" <wking@tremily.us>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH 7/7] doc/INSTALL: Remove rst2man reference and other\r
+       updates\r
+In-Reply-To:\r
+ <edf9a674bc1f41917caead8d38b5f09295a9d1bd.1396718720.git.wking@tremily.us>\r
+References: <cover.1396718720.git.wking@tremily.us>\r
+       <edf9a674bc1f41917caead8d38b5f09295a9d1bd.1396718720.git.wking@tremily.us>\r
+User-Agent: Notmuch/0.17+170~gf516b7c (http://notmuchmail.org) Emacs/24.3.1\r
+       (x86_64-pc-linux-gnu)\r
+Date: Sat, 05 Apr 2014 17:35:49 -0300\r
+Message-ID: <874n271plm.fsf@maritornes.cs.unb.ca>\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, 05 Apr 2014 20:37:12 -0000\r
+\r
+"W. Trevor King" <wking@tremily.us> writes:\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
+most of those those targets now start with sphinx-\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
+build build\r
+>  \r
+> -     'make install-{man|info|html|pdf}'\r
+> +  make install-{man|info|html|pdf}\r
+>  \r
+\r
+this is not your bug per se, but while we're fixing docs, most of those\r
+targets don't exist.\r
+\r
+> -Building the man pages\r
+> -----------------------\r
+> +Building the man Docutils\r
+> +-------------------------\r
+>  \r
+\r
++ with\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
+\r
+This should mention the relevant variables, since the targets are the\r
+same in both cases\r
+\r
+Finally, I don't really object to rewriting doc/INSTALL in rst, but I\r
+wonder if we should rename it to INSTALL.rst\r
+\r
+d\r