From: David Bremner Date: Sat, 5 Apr 2014 20:35:49 +0000 (+2100) Subject: Re: [PATCH 7/7] doc/INSTALL: Remove rst2man reference and other updates X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=e112ffc66e4e8ba090e292239efdece2fe3bfe6e;p=notmuch-archives.git Re: [PATCH 7/7] doc/INSTALL: Remove rst2man reference and other updates --- diff --git a/9f/456f8d7788fcaa3cbfb0c1eef034d369b24307 b/9f/456f8d7788fcaa3cbfb0c1eef034d369b24307 new file mode 100644 index 000000000..10ecf2302 --- /dev/null +++ b/9f/456f8d7788fcaa3cbfb0c1eef034d369b24307 @@ -0,0 +1,137 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 1C8C0431FBF + for ; Sat, 5 Apr 2014 13:37:12 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: 0 +X-Spam-Level: +X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none] + autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id cPzvoISenwEN for ; + Sat, 5 Apr 2014 13:37:04 -0700 (PDT) +Received: from mx.xen14.node3324.gplhost.com (gitolite.debian.net + [87.98.215.224]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id C5897431FAF + for ; Sat, 5 Apr 2014 13:37:04 -0700 (PDT) +Received: from remotemail by mx.xen14.node3324.gplhost.com with local (Exim + 4.72) (envelope-from ) + id 1WWXJt-0000Xt-1Y; Sat, 05 Apr 2014 20:36:05 +0000 +Received: (nullmailer pid 11036 invoked by uid 1000); Sat, 05 Apr 2014 + 20:35:49 -0000 +From: David Bremner +To: "W. Trevor King" , notmuch@notmuchmail.org +Subject: Re: [PATCH 7/7] doc/INSTALL: Remove rst2man reference and other + updates +In-Reply-To: + +References: + +User-Agent: Notmuch/0.17+170~gf516b7c (http://notmuchmail.org) Emacs/24.3.1 + (x86_64-pc-linux-gnu) +Date: Sat, 05 Apr 2014 17:35:49 -0300 +Message-ID: <874n271plm.fsf@maritornes.cs.unb.ca> +MIME-Version: 1.0 +Content-Type: text/plain +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Sat, 05 Apr 2014 20:37:12 -0000 + +"W. Trevor King" writes: + +> The rst2man target was removed in 9d9a700 (doc: build man pages at +> build time; introduce HAVE_SPHINX, HAVE_RST2MAN, 2014-03-13), but a +> reference in the install docs slipped through. While I was removing +> that reference, I also: +> +> * Converted doc/INSTALL to reStructuredText, so I can link to Sphinx +> and Docutils directly. Not everyone has access to Debian's +> python-docutils, so it's better to be genric here. +> * Converted from an unordered list to paragraphs, because I think it +> flows better. +> * Dropped the rst2man no-automatic-install caveat. I don't think this +> applies to the current code, although I haven't tried to track down +> a commit that adds the automatic-install support. Anyhow, +> +> $ make HAVE_SPHINX=0 RST2MAN=/usr/bin/rst2man.py DESTDIR=/tmp/ install-man +> +> works for me. +> --- +> doc/INSTALL | 34 ++++++++++++++++++++-------------- +> 1 file changed, 20 insertions(+), 14 deletions(-) +> +> diff --git a/doc/INSTALL b/doc/INSTALL +> index e37c2b9..91222f9 100644 +> --- a/doc/INSTALL +> +++ b/doc/INSTALL +> @@ -1,24 +1,30 @@ +> This file contains some more detailed information about building and +> installing the documentation. +> +> -Building with sphinx. +> ---------------------- +> +Building with Sphinx +> +-------------------- +> +> -- You need sphinx at least version 1.0. +> +With Sphinx_ version 1.0 or greater, you can build man, info, html, +> +and pdf versions of the docs (currently only the man pages) with:: +> +> -- You can build build and install man pages with 'make install-man' +> + make build-{man|info|html|pdf} + +most of those those targets now start with sphinx- +> +> -- You can build man, info, html, and pdf versions of the docs +> - (currently only the man pages) with +> +You can build build and install the docs (currently only the man +> +pages) with:: + +build build +> +> - 'make install-{man|info|html|pdf}' +> + make install-{man|info|html|pdf} +> + +this is not your bug per se, but while we're fixing docs, most of those +targets don't exist. + +> -Building the man pages +> ----------------------- +> +Building the man Docutils +> +------------------------- +> + ++ with + +> -- You can build the man pages with rst2man (from python-docutils) with +> - 'make rst2man'. +> +If you don't have Sphinx installed, you can still build the man-page +> +version of the docs using rst2man (from Docutils_):: +> +> -- Currently there is no support to automagically install the resulting +> - nroff files, but it should work to modify the target install-man +> - in doc/Makefile.local. + +This should mention the relevant variables, since the targets are the +same in both cases + +Finally, I don't really object to rewriting doc/INSTALL in rst, but I +wonder if we should rename it to INSTALL.rst + +d