Re: [PATCH 2/2] doc: build and install doxygen api docs
authorTomi Ollila <tomi.ollila@iki.fi>
Sun, 6 Apr 2014 07:57:08 +0000 (10:57 +0300)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:01:20 +0000 (10:01 -0800)
f3/b371c3e64db4ceae1f7ecae3c0121e24421d5c [new file with mode: 0644]

diff --git a/f3/b371c3e64db4ceae1f7ecae3c0121e24421d5c b/f3/b371c3e64db4ceae1f7ecae3c0121e24421d5c
new file mode 100644 (file)
index 0000000..a6ee5db
--- /dev/null
@@ -0,0 +1,153 @@
+Return-Path: <tomi.ollila@iki.fi>\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 66B58431FB6\r
+       for <notmuch@notmuchmail.org>; Sun,  6 Apr 2014 00:57:26 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 1.775\r
+X-Spam-Level: *\r
+X-Spam-Status: No, score=1.775 tagged_above=-999 required=5\r
+       tests=[URIBL_BLACK=1.775] 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 xCePdtFJSO8G for <notmuch@notmuchmail.org>;\r
+       Sun,  6 Apr 2014 00:57:19 -0700 (PDT)\r
+Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
+       by olra.theworths.org (Postfix) with ESMTP id 8BE48431FAF\r
+       for <notmuch@notmuchmail.org>; Sun,  6 Apr 2014 00:57:18 -0700 (PDT)\r
+Received: from guru.guru-group.fi (localhost [IPv6:::1])\r
+       by guru.guru-group.fi (Postfix) with ESMTP id A3F75100086;\r
+       Sun,  6 Apr 2014 10:57:08 +0300 (EEST)\r
+From: Tomi Ollila <tomi.ollila@iki.fi>\r
+To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH 2/2] doc: build and install doxygen api docs\r
+In-Reply-To: <1396749744-19638-3-git-send-email-david@tethera.net>\r
+References: <1389000116-16702-1-git-send-email-tomi.ollila@iki.fi>\r
+       <1396749744-19638-1-git-send-email-david@tethera.net>\r
+       <1396749744-19638-3-git-send-email-david@tethera.net>\r
+User-Agent: Notmuch/0.17+174~gef82849 (http://notmuchmail.org) Emacs/24.3.1\r
+       (x86_64-unknown-linux-gnu)\r
+X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL\r
+       $[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F\r
+       !)g;OY^,BjTbr)Np:%c_o'jj,Z\r
+Date: Sun, 06 Apr 2014 10:57:08 +0300\r
+Message-ID: <m2a9byc2ln.fsf@guru.guru-group.fi>\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: Sun, 06 Apr 2014 07:57:26 -0000\r
+\r
+On Sun, Apr 06 2014, David Bremner <david@tethera.net> wrote:\r
+\r
+> Add to the build-man and install-man targets. We also stop hardcoding\r
+> the version information into doxygen.cfg\r
+> ---\r
+>  doc/Makefile.local | 14 ++++++++++++--\r
+>  doc/doxygen.cfg    |  4 ++--\r
+>  2 files changed, 14 insertions(+), 4 deletions(-)\r
+>\r
+> diff --git a/doc/Makefile.local b/doc/Makefile.local\r
+> index 0980c71..5189f97 100644\r
+> --- a/doc/Makefile.local\r
+> +++ b/doc/Makefile.local\r
+> @@ -12,6 +12,8 @@ mkdocdeps := python $(srcdir)/$(dir)/mkdocdeps.py\r
+>  \r
+>  # Internal variables.\r
+>  ALLSPHINXOPTS   := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(srcdir)/$(dir)\r
+> +APIMAN              := $(DOCBUILDDIR)/man/man3/notmuch.3\r
+> +DOXYFILE    := $(dir)/doxygen.cfg\r
+>  \r
+>  .PHONY: sphinx-html sphinx-texinfo sphinx-info\r
+>  \r
+> @@ -31,7 +33,7 @@ sphinx-info: sphinx-texinfo\r
+>  \r
+>  -include $(dir)/docdeps.mk\r
+>  \r
+> -MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES})\r
+> +MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES} ${APIMAN})\r
+>  \r
+>  # Use the man page converter that is available. We should never depend\r
+>  # on MAN_ROFF_FILES if a converter is not available.\r
+> @@ -59,16 +61,24 @@ else\r
+>  build-man: ${MAN_GZIP_FILES}\r
+>  install-man: ${MAN_GZIP_FILES}\r
+>      mkdir -p "$(DESTDIR)$(mandir)/man1"\r
+> +    mkdir -p "$(DESTDIR)$(mandir)/man3"\r
+>      mkdir -p "$(DESTDIR)$(mandir)/man5"\r
+>      mkdir -p "$(DESTDIR)$(mandir)/man7"\r
+>      install -m0644 $(DOCBUILDDIR)/man/man1/*.1.gz $(DESTDIR)/$(mandir)/man1\r
+> +    install -m0644 $(DOCBUILDDIR)/man/man3/*.3.gz $(DESTDIR)/$(mandir)/man3\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
+>  endif\r
+>  \r
+> +$(APIMAN): $(dir)/version.dox $(dir)/doxygen.cfg $(srcdir)/lib/notmuch.h\r
+> +    doxygen $(DOXYFILE)\r
+> +\r
+> +$(dir)/version.dox: $(srcdir)/version\r
+> +    sed -e 's/^/PROJECT_NAME = \"Notmuch /' -e 's/$$/\"/' < $< > $@\r
+> +\r
+\r
+LGTM, although:\r
+\r
+      echo "PROJECT_NAME = \"Notmuch `cat $<`\"" >$@\r
+\r
+no, \r
+\r
+      echo 'PROJECT_NAME = "Notmuch $(VERSION)"' > $@\r
+\r
+\r
+... and, the dependency should be to version.stamp (w/o $(srcdir)) after\r
+\r
+id:1395261431-24668-1b-git-send-email-tomi.ollila@iki.fi is merged :D\r
+\r
+... as especially developers need to know the exact version they have\r
+in their git tree instead of last released one.\r
+\r
+I marked my patch in this thread obsolete (my previous statement makes this\r
+obvious) and 1/1 on this series ready.\r
+\r
+Tomi\r
+\r
+\r
+\r
+>  $(dir)/docdeps.mk: $(dir)/conf.py $(dir)/mkdocdeps.py\r
+>      $(mkdocdeps) $(srcdir)/doc $(DOCBUILDDIR) $@\r
+>  \r
+>  CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk $(dir)/man.stamp\r
+> -CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES)\r
+> +CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/version.dox\r
+> diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg\r
+> index 65d5fb5..bf9f075 100644\r
+> --- a/doc/doxygen.cfg\r
+> +++ b/doc/doxygen.cfg\r
+> @@ -4,11 +4,11 @@\r
+>  # Project related configuration options\r
+>  #---------------------------------------------------------------------------\r
+>  DOXYFILE_ENCODING      = UTF-8\r
+> -PROJECT_NAME           = "Notmuch 0.17"\r
+> +@INCLUDE           =  "doc/version.dox"\r
+>  PROJECT_NUMBER         =\r
+>  PROJECT_BRIEF          =\r
+>  PROJECT_LOGO           =\r
+> -OUTPUT_DIRECTORY       =\r
+> +OUTPUT_DIRECTORY       = doc/_build\r
+>  CREATE_SUBDIRS         = NO\r
+>  OUTPUT_LANGUAGE        = English\r
+>  BRIEF_MEMBER_DESC      = YES\r
+> -- \r
+> 1.9.0\r