From 39cd2ee2a89e95a04d39c0088495eb38e32ac83d Mon Sep 17 00:00:00 2001 From: Tomi Ollila Date: Wed, 5 Mar 2014 20:11:02 +0200 Subject: [PATCH] Re: convert man pages to sphinx --- a0/c41918e506740108c0364e48072e64497dce87 | 90 +++++++++++++++++++++++ 1 file changed, 90 insertions(+) create mode 100644 a0/c41918e506740108c0364e48072e64497dce87 diff --git a/a0/c41918e506740108c0364e48072e64497dce87 b/a0/c41918e506740108c0364e48072e64497dce87 new file mode 100644 index 000000000..af483e8c1 --- /dev/null +++ b/a0/c41918e506740108c0364e48072e64497dce87 @@ -0,0 +1,90 @@ +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 0E89C431FBD + for ; Wed, 5 Mar 2014 10:11:18 -0800 (PST) +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 tbx0gb+JqZio for ; + Wed, 5 Mar 2014 10:11:10 -0800 (PST) +Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34]) + by olra.theworths.org (Postfix) with ESMTP id 9451C431FAE + for ; Wed, 5 Mar 2014 10:11:10 -0800 (PST) +Received: from guru.guru-group.fi (localhost [IPv6:::1]) + by guru.guru-group.fi (Postfix) with ESMTP id 6F37010008F; + Wed, 5 Mar 2014 20:11:02 +0200 (EET) +From: Tomi Ollila +To: David Bremner , notmuch@notmuchmail.org +Subject: Re: convert man pages to sphinx +In-Reply-To: <1394031395-8014-1-git-send-email-david@tethera.net> +References: <1394031395-8014-1-git-send-email-david@tethera.net> +User-Agent: Notmuch/0.17+112~g4e0c1d5 (http://notmuchmail.org) Emacs/24.3.1 + (x86_64-unknown-linux-gnu) +X-Face: HhBM'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: Wed, 05 Mar 2014 18:11:18 -0000 + +On Wed, Mar 05 2014, David Bremner wrote: + +> This is the first version actually integrated into the build system. +> +> If people think the results are OK, I think we should move merge +> because it has become more difficult than I thought to update the rst +> files from man page changes. +> +> Of course we can/should still fix any glaring problems. + +Looks good -- some things that caught my attention.. + +in doc/Makefile.local + + -include $(dir)/docdeps.mk -- so that we don't get complaint about missing + file + + rm -f $@; gzip --stdout > $@ < $^ -- as -k option is pretty new in gzip + world (bzip2 & xz seems to have had it longer (always?)) + The 'rm -f $@' part is modeled after bzip2 manual page where it says + hard links are broken... + +doc/.gitignore -- is missing, docdeps.mk & _build there + +both "make rst2man" and "make sphinx-man SPHINXBUILD=sphinx-1.0-build" seems +to do good job. I happened to notice that one reference to other manual +page was still underlined instead of bolded, manually checking +the output of grep -n '([0-9])' **/*.rst indicates that the one in +man1/notmuch.rst:88: is (probably) the only one. + + +Tomi + + +> +> One thing that is not here at all is any kind of automation of the +> fallback for people without (recent) sphinx. +> +> I also left the nroff man sources in the tree, but if I merge this series +> (or something similar) I plan to delete them. -- 2.26.2