[Patch v3 2/4] doc: build man pages into hierarchy, fix help test.
authorDavid Bremner <david@tethera.net>
Thu, 13 Mar 2014 03:21:15 +0000 (00:21 +2100)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:00:45 +0000 (10:00 -0800)
14/2610255bfafb875830d951cf43a20f9af90e39 [new file with mode: 0644]

diff --git a/14/2610255bfafb875830d951cf43a20f9af90e39 b/14/2610255bfafb875830d951cf43a20f9af90e39
new file mode 100644 (file)
index 0000000..9dc8276
--- /dev/null
@@ -0,0 +1,125 @@
+Return-Path: <bremner@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 C634F429E27\r
+       for <notmuch@notmuchmail.org>; Wed, 12 Mar 2014 20:22:06 -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 BWl1J40xZ5O4 for <notmuch@notmuchmail.org>;\r
+       Wed, 12 Mar 2014 20:22:02 -0700 (PDT)\r
+Received: from yantan.tethera.net (yantan.tethera.net [199.188.72.155])\r
+       (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id C2138431FC2\r
+       for <notmuch@notmuchmail.org>; Wed, 12 Mar 2014 20:21:46 -0700 (PDT)\r
+Received: from remotemail by yantan.tethera.net with local (Exim 4.80)\r
+       (envelope-from <bremner@tethera.net>)\r
+       id 1WNwDK-0000DA-Dt; Thu, 13 Mar 2014 00:21:46 -0300\r
+Received: (nullmailer pid 25679 invoked by uid 1000); Thu, 13 Mar 2014\r
+       03:21:29 -0000\r
+From: David Bremner <david@tethera.net>\r
+To: notmuch@notmuchmail.org\r
+Subject: [Patch v3 2/4] doc: build man pages into hierarchy, fix help test.\r
+Date: Thu, 13 Mar 2014 00:21:15 -0300\r
+Message-Id: <1394680877-25572-3-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 1.8.5.3\r
+In-Reply-To: <1394680877-25572-1-git-send-email-david@tethera.net>\r
+References: <m238iozjmc.fsf@guru.guru-group.fi>\r
+       <1394680877-25572-1-git-send-email-david@tethera.net>\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: Thu, 13 Mar 2014 03:22:07 -0000\r
+\r
+It turns out there was a reason the old man pages were stored in a man\r
+compatible hierarchy, namely so that we could run man on them before\r
+installing.\r
+\r
+Hardcode doc build location into test suite.  This isn't ideal, but\r
+let's unbreak the test suite for now.\r
+---\r
+ doc/Makefile.local      | 11 +++++++----\r
+ doc/mkdocdeps.py        |  2 +-\r
+ test/test-lib-common.sh |  4 ++--\r
+ 3 files changed, 10 insertions(+), 7 deletions(-)\r
+\r
+diff --git a/doc/Makefile.local b/doc/Makefile.local\r
+index 23f4095..fab6d48 100644\r
+--- a/doc/Makefile.local\r
++++ b/doc/Makefile.local\r
+@@ -40,7 +40,10 @@ ${MAN_ROFF_FILES}: ${dir}/man.stamp\r
+ $(dir)/man.stamp: ${MAN_RST_FILES}\r
+ ifeq ($(HAVE_SPHINX),1)\r
+       $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(DOCBUILDDIR)/man\r
+-      touch $@\r
++      for section in 1 5 7; do \\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) $(DOCBUILDDIR)/.. $(DOCBUILDDIR)/man\r
+       touch $@\r
+@@ -52,9 +55,9 @@ install-man: ${MAN_GZIP_FILES}\r
+       mkdir -p "$(DESTDIR)$(mandir)/man1"\r
+       mkdir -p "$(DESTDIR)$(mandir)/man5"\r
+       mkdir -p "$(DESTDIR)$(mandir)/man7"\r
+-      install -m0644 $(DOCBUILDDIR)/man/*.1.gz $(DESTDIR)/$(mandir)/man1\r
+-      install -m0644 $(DOCBUILDDIR)/man/*.5.gz $(DESTDIR)/$(mandir)/man5\r
+-      install -m0644 $(DOCBUILDDIR)/man/*.7.gz $(DESTDIR)/$(mandir)/man7\r
++      install -m0644 $(DOCBUILDDIR)/man/man1/*.1.gz $(DESTDIR)/$(mandir)/man1\r
++      install -m0644 $(DOCBUILDDIR)/man/man5/*.5.gz $(DESTDIR)/$(mandir)/man5\r
++      install -m0644 $(DOCBUILDDIR)/man/man7/*.7.gz $(DESTDIR)/$(mandir)/man7\r
+       cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz\r
\r
+ $(dir)/docdeps.mk: $(dir)/conf.py $(dir)/mkdocdeps.py\r
+diff --git a/doc/mkdocdeps.py b/doc/mkdocdeps.py\r
+index e61bea6..3effdd8 100644\r
+--- a/doc/mkdocdeps.py\r
++++ b/doc/mkdocdeps.py\r
+@@ -10,7 +10,7 @@ rst_files = []\r
+ out=open(outfile,'w')\r
+ for page in man_pages:\r
+     rst_files = rst_files + ["doc/{0:s}.rst".format(page[0])]\r
+-    roff_files = roff_files + ["{0:s}/man/{1:s}.{2:d}".format(builddir,page[1],page[4])]\r
++    roff_files = roff_files + ["{0:s}/man/{1:s}.{2:d}".format(builddir,page[0],page[4])]\r
\r
+ out.write ('MAN_ROFF_FILES := ' + ' \\\n\t'.join(roff_files)+'\n')\r
+ out.write ('MAN_RST_FILES := ' + ' \\\n\t'.join(rst_files)+'\n')\r
+diff --git a/test/test-lib-common.sh b/test/test-lib-common.sh\r
+index e1eaa5a..892991e 100644\r
+--- a/test/test-lib-common.sh\r
++++ b/test/test-lib-common.sh\r
+@@ -98,12 +98,12 @@ then\r
+       PATH=$GIT_VALGRIND/bin:$PATH\r
+       GIT_EXEC_PATH=$GIT_VALGRIND/bin\r
+       export GIT_VALGRIND\r
+-      test -n "$notmuch_path" && MANPATH="$notmuch_path/man:$MANPATH"\r
++      test -n "$notmuch_path" && MANPATH="$notmuch_path/doc/_build/man"\r
+ else # normal case\r
+       if test -n "$notmuch_path"\r
+               then\r
+                       PATH="$notmuch_path:$PATH"\r
+-                      MANPATH="$notmuch_path/man:$MANPATH"\r
++                      MANPATH="$notmuch_path/doc/_build/man"\r
+               fi\r
+ fi\r
+ export PATH MANPATH\r
+-- \r
+1.8.5.3\r
+\r