7d/c202981927a39523f4c9f7562a74536eb5979a

   1 Return-Path: <bremner@tethera.net>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id C4559431FC2\r
   6         for <notmuch@notmuchmail.org>; Thu,  6 Mar 2014 05:21:10 -0800 (PST)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: 0\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
  12         autolearn=disabled\r
  13 Received: from olra.theworths.org ([127.0.0.1])\r
  14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  15         with ESMTP id jkOL3MzxiBgn for <notmuch@notmuchmail.org>;\r
  16         Thu,  6 Mar 2014 05:21:06 -0800 (PST)\r
  17 Received: from yantan.tethera.net (yantan.tethera.net [199.188.72.155])\r
  18         (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))\r
  19         (No client certificate requested)\r
  20         by olra.theworths.org (Postfix) with ESMTPS id 3FD66431FBF\r
  21         for <notmuch@notmuchmail.org>; Thu,  6 Mar 2014 05:21:06 -0800 (PST)\r
  22 Received: from remotemail by yantan.tethera.net with local (Exim 4.80)\r
  23         (envelope-from <bremner@tethera.net>)\r
  24         id 1WLYES-0000vR-9M; Thu, 06 Mar 2014 09:21:04 -0400\r
  25 Received: (nullmailer pid 2400 invoked by uid 1000); Thu, 06 Mar 2014\r
  26         13:20:57 -0000\r
  27 From: David Bremner <david@tethera.net>\r
  28 To: notmuch@notmuchmail.org\r
  29 Subject: [PATCH v2 3/4] doc: install sphinx version of man pages\r
  30 Date: Thu,  6 Mar 2014 09:20:47 -0400\r
  31 Message-Id: <1394112048-2151-4-git-send-email-david@tethera.net>\r
  32 X-Mailer: git-send-email 1.8.5.3\r
  33 In-Reply-To: <1394112048-2151-1-git-send-email-david@tethera.net>\r
  34 References: <m2d2i0jz2h.fsf@guru.guru-group.fi>\r
  35         <1394112048-2151-1-git-send-email-david@tethera.net>\r
  36 X-BeenThere: notmuch@notmuchmail.org\r
  37 X-Mailman-Version: 2.1.13\r
  38 Precedence: list\r
  39 List-Id: "Use and development of the notmuch mail system."\r
  40         <notmuch.notmuchmail.org>\r
  41 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  42         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  43 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  44 List-Post: <mailto:notmuch@notmuchmail.org>\r
  45 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  46 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  47         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  48 X-List-Received-Date: Thu, 06 Mar 2014 13:21:11 -0000\r
  49 \r
  50 The python script mkdocdeps.py is used to import the list of man pages\r
  51 from the sphinx configuration to make.\r
  52 \r
  53 This will delete the (release only) target update-man-versions. This\r
  54 will be replaced in a followup commit.\r
  55 ---\r
  56  Makefile           |  2 +-\r
  57  Makefile.local     |  2 +-\r
  58  doc/Makefile.local | 27 ++++++++++++++++++++++++++-\r
  59  doc/mkdocdeps.py   | 13 +++++++++++++\r
  60  man/Makefile.local | 55 ------------------------------------------------------\r
  61  5 files changed, 41 insertions(+), 58 deletions(-)\r
  62  create mode 100644 doc/mkdocdeps.py\r
  63  delete mode 100644 man/Makefile.local\r
  64 \r
  65 diff --git a/Makefile b/Makefile\r
  66 index 39f0e62..f53bec0 100644\r
  67 --- a/Makefile\r
  68 +++ b/Makefile\r
  69 @@ -5,7 +5,7 @@ all:\r
  70  # List all subdirectories here. Each contains its own Makefile.local.\r
  71  # Use of '=', without '+=', seems to be required for out-of-tree\r
  72  # builds to work.\r
  73 -subdirs = compat completion doc emacs lib man parse-time-string performance-test util test\r
  74 +subdirs = compat completion doc emacs lib parse-time-string performance-test util test\r
  75  \r
  76  # We make all targets depend on the Makefiles themselves.\r
  77  global_deps = Makefile Makefile.config Makefile.local \\r
  78 diff --git a/Makefile.local b/Makefile.local\r
  79 index 174506c..5f797ad 100644\r
  80 --- a/Makefile.local\r
  81 +++ b/Makefile.local\r
  82 @@ -95,7 +95,7 @@ dist: $(TAR_FILE)\r
  83  \r
  84  .PHONY: update-versions\r
  85  \r
  86 -update-versions: update-man-versions\r
  87 +update-versions:\r
  88         sed -i "s/^__VERSION__[[:blank:]]*=.*$$/__VERSION__ = \'${VERSION}\'/" $(PV_FILE)\r
  89  \r
  90  # We invoke make recursively only to force ordering of our phony\r
  91 diff --git a/doc/Makefile.local b/doc/Makefile.local\r
  92 index 4719247..fd64f70 100644\r
  93 --- a/doc/Makefile.local\r
  94 +++ b/doc/Makefile.local\r
  95 @@ -8,6 +8,7 @@ SPHINXBUILD   = sphinx-build\r
  96  DOCBUILDDIR      := $(dir)/_build\r
  97  \r
  98  prerst2man := python $(dir)/prerst2man.py\r
  99 +mkdocdeps := python $(dir)/mkdocdeps.py\r
 100  \r
 101  # Internal variables.\r
 102  ALLSPHINXOPTS   := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(dir)\r
 103 @@ -15,6 +16,11 @@ ALLSPHINXOPTS   := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(dir)\r
 104  .PHONY: sphinx-html sphinx-man sphinx-texinfo sphinx-info\r
 105  .PHONY: rst2man\r
 106  \r
 107 +.PHONY: install-man\r
 108 +\r
 109 +%.gz: %\r
 110 +       rm -f $@ && gzip --stdout $^ > $@\r
 111 +\r
 112  sphinx-html:\r
 113         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(DOCBUILDDIR)/html\r
 114  \r
 115 @@ -31,4 +37,23 @@ sphinx-info: sphinx-texinfo\r
 116  rst2man:\r
 117         $(prerst2man) $(DOCBUILDDIR)/.. $(DOCBUILDDIR)/man\r
 118  \r
 119 -CLEAN := $(CLEAN) $(DOCBUILDDIR)\r
 120 +-include $(dir)/docdeps.mk\r
 121 +\r
 122 +MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES})\r
 123 +\r
 124 +${MAN_ROFF_FILES} : sphinx-man\r
 125 +\r
 126 +install-man: ${MAN_GZIP_FILES}\r
 127 +       mkdir -p "$(DESTDIR)$(mandir)/man1"\r
 128 +       mkdir -p "$(DESTDIR)$(mandir)/man5"\r
 129 +       mkdir -p "$(DESTDIR)$(mandir)/man7"\r
 130 +       install -m0644 $(DOCBUILDDIR)/man/*.1.gz $(DESTDIR)/$(mandir)/man1\r
 131 +       install -m0644 $(DOCBUILDDIR)/man/*.5.gz $(DESTDIR)/$(mandir)/man5\r
 132 +       install -m0644 $(DOCBUILDDIR)/man/*.7.gz $(DESTDIR)/$(mandir)/man7\r
 133 +       cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz\r
 134 +\r
 135 +\r
 136 +$(dir)/docdeps.mk: $(dir)/conf.py $(dir)/mkdocdeps.py\r
 137 +       $(mkdocdeps) $< $(DOCBUILDDIR) $@\r
 138 +\r
 139 +CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk\r
 140 diff --git a/doc/mkdocdeps.py b/doc/mkdocdeps.py\r
 141 new file mode 100644\r
 142 index 0000000..2f4a959\r
 143 --- /dev/null\r
 144 +++ b/doc/mkdocdeps.py\r
 145 @@ -0,0 +1,13 @@\r
 146 +from sys import argv\r
 147 +conffile = argv[1]\r
 148 +builddir = argv[2]\r
 149 +outfile = argv[3]\r
 150 +\r
 151 +execfile(conffile)\r
 152 +\r
 153 +roff_files = []\r
 154 +out=open(outfile,'w')\r
 155 +for page in man_pages:\r
 156 +    roff_files = roff_files + ["{0:s}/man/{1:s}.{2:d}".format(builddir,page[1],page[4])]\r
 157 +\r
 158 +out.write ('MAN_ROFF_FILES := ' + ' \\\n\t'.join(roff_files)+'\n')\r
 159 diff --git a/man/Makefile.local b/man/Makefile.local\r
 160 deleted file mode 100644\r
 161 index 57910b7..0000000\r
 162 --- a/man/Makefile.local\r
 163 +++ /dev/null\r
 164 @@ -1,55 +0,0 @@\r
 165 -# -*- Makefile -*-\r
 166 -\r
 167 -dir := man\r
 168 -\r
 169 -# this variable seems to be needed to prevent lazy evaluation causing\r
 170 -# problems with $(dir) changing values.\r
 171 -MAIN_PAGE := $(dir)/man1/notmuch.1\r
 172 -\r
 173 -MAN1 := \\r
 174 -       $(MAIN_PAGE) \\r
 175 -       $(dir)/man1/notmuch-compact.1 \\r
 176 -       $(dir)/man1/notmuch-config.1 \\r
 177 -       $(dir)/man1/notmuch-count.1 \\r
 178 -       $(dir)/man1/notmuch-dump.1 \\r
 179 -       $(dir)/man1/notmuch-restore.1 \\r
 180 -       $(dir)/man1/notmuch-insert.1 \\r
 181 -       $(dir)/man1/notmuch-new.1 \\r
 182 -       $(dir)/man1/notmuch-reply.1 \\r
 183 -       $(dir)/man1/notmuch-search.1 \\r
 184 -       $(dir)/man1/notmuch-show.1 \\r
 185 -       $(dir)/man1/notmuch-tag.1\r
 186 -\r
 187 -MAN5 := $(dir)/man5/notmuch-hooks.5\r
 188 -MAN7 := $(dir)/man7/notmuch-search-terms.7\r
 189 -\r
 190 -MAN1_GZ := $(addsuffix .gz,$(MAN1))\r
 191 -MAN5_GZ := $(addsuffix .gz,$(MAN5))\r
 192 -MAN7_GZ := $(addsuffix .gz,$(MAN7))\r
 193 -\r
 194 -MAN_SOURCE := $(MAN1) $(MAN5) $(MAN7)\r
 195 -MAN_BACKUP := $(addsuffix .bak,$(MAN_SOURCE))\r
 196 -COMPRESSED_MAN := $(MAN1_GZ) $(MAN5_GZ) $(MAN7_GZ)\r
 197 -\r
 198 -%.gz: %\r
 199 -       gzip --stdout $^ > $@\r
 200 -\r
 201 -.PHONY: install-man update-man-versions\r
 202 -\r
 203 -install-man: $(COMPRESSED_MAN)\r
 204 -       mkdir -p "$(DESTDIR)$(mandir)/man1"\r
 205 -       mkdir -p "$(DESTDIR)$(mandir)/man5"\r
 206 -       mkdir -p "$(DESTDIR)$(mandir)/man7"\r
 207 -       install -m0644 $(MAN1_GZ) $(DESTDIR)/$(mandir)/man1\r
 208 -       install -m0644 $(MAN5_GZ) $(DESTDIR)/$(mandir)/man5\r
 209 -       install -m0644 $(MAN7_GZ) $(DESTDIR)/$(mandir)/man7\r
 210 -       cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz\r
 211 -\r
 212 -update-man-versions: $(MAN_SOURCE)\r
 213 -       for file in $(MAN_SOURCE); do \\r
 214 -           cp $$file $$file.bak ; \\r
 215 -           sed "s/^.TH NOTMUCH\([^[:blank:]]*\) \([1-9]\) .*$$/.TH NOTMUCH\1 \2 ${DATE} \"Notmuch ${VERSION}\"/" \\r
 216 -               < $$file.bak > $$file; \\r
 217 -       done\r
 218 -\r
 219 -CLEAN := $(CLEAN) $(COMPRESSED_MAN) $(MAN_BACKUP)\r
 220 -- \r
 221 1.8.5.3\r
 222 \r