f3/b371c3e64db4ceae1f7ecae3c0121e24421d5c

   1 Return-Path: <tomi.ollila@iki.fi>\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 66B58431FB6\r
   6         for <notmuch@notmuchmail.org>; Sun,  6 Apr 2014 00:57:26 -0700 (PDT)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: 1.775\r
  10 X-Spam-Level: *\r
  11 X-Spam-Status: No, score=1.775 tagged_above=-999 required=5\r
  12         tests=[URIBL_BLACK=1.775] 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 xCePdtFJSO8G for <notmuch@notmuchmail.org>;\r
  16         Sun,  6 Apr 2014 00:57:19 -0700 (PDT)\r
  17 Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34])\r
  18         by olra.theworths.org (Postfix) with ESMTP id 8BE48431FAF\r
  19         for <notmuch@notmuchmail.org>; Sun,  6 Apr 2014 00:57:18 -0700 (PDT)\r
  20 Received: from guru.guru-group.fi (localhost [IPv6:::1])\r
  21         by guru.guru-group.fi (Postfix) with ESMTP id A3F75100086;\r
  22         Sun,  6 Apr 2014 10:57:08 +0300 (EEST)\r
  23 From: Tomi Ollila <tomi.ollila@iki.fi>\r
  24 To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org\r
  25 Subject: Re: [PATCH 2/2] doc: build and install doxygen api docs\r
  26 In-Reply-To: <1396749744-19638-3-git-send-email-david@tethera.net>\r
  27 References: <1389000116-16702-1-git-send-email-tomi.ollila@iki.fi>\r
  28         <1396749744-19638-1-git-send-email-david@tethera.net>\r
  29         <1396749744-19638-3-git-send-email-david@tethera.net>\r
  30 User-Agent: Notmuch/0.17+174~gef82849 (http://notmuchmail.org) Emacs/24.3.1\r
  31         (x86_64-unknown-linux-gnu)\r
  32 X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL\r
  33         $[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F\r
  34         !)g;OY^,BjTbr)Np:%c_o'jj,Z\r
  35 Date: Sun, 06 Apr 2014 10:57:08 +0300\r
  36 Message-ID: <m2a9byc2ln.fsf@guru.guru-group.fi>\r
  37 MIME-Version: 1.0\r
  38 Content-Type: text/plain\r
  39 X-BeenThere: notmuch@notmuchmail.org\r
  40 X-Mailman-Version: 2.1.13\r
  41 Precedence: list\r
  42 List-Id: "Use and development of the notmuch mail system."\r
  43         <notmuch.notmuchmail.org>\r
  44 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  45         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  46 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  47 List-Post: <mailto:notmuch@notmuchmail.org>\r
  48 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  49 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  50         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  51 X-List-Received-Date: Sun, 06 Apr 2014 07:57:26 -0000\r
  52 \r
  53 On Sun, Apr 06 2014, David Bremner <david@tethera.net> wrote:\r
  54 \r
  55 > Add to the build-man and install-man targets. We also stop hardcoding\r
  56 > the version information into doxygen.cfg\r
  57 > ---\r
  58 >  doc/Makefile.local | 14 ++++++++++++--\r
  59 >  doc/doxygen.cfg    |  4 ++--\r
  60 >  2 files changed, 14 insertions(+), 4 deletions(-)\r
  61 >\r
  62 > diff --git a/doc/Makefile.local b/doc/Makefile.local\r
  63 > index 0980c71..5189f97 100644\r
  64 > --- a/doc/Makefile.local\r
  65 > +++ b/doc/Makefile.local\r
  66 > @@ -12,6 +12,8 @@ mkdocdeps := python $(srcdir)/$(dir)/mkdocdeps.py\r
  67 >  \r
  68 >  # Internal variables.\r
  69 >  ALLSPHINXOPTS   := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(srcdir)/$(dir)\r
  70 > +APIMAN               := $(DOCBUILDDIR)/man/man3/notmuch.3\r
  71 > +DOXYFILE     := $(dir)/doxygen.cfg\r
  72 >  \r
  73 >  .PHONY: sphinx-html sphinx-texinfo sphinx-info\r
  74 >  \r
  75 > @@ -31,7 +33,7 @@ sphinx-info: sphinx-texinfo\r
  76 >  \r
  77 >  -include $(dir)/docdeps.mk\r
  78 >  \r
  79 > -MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES})\r
  80 > +MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES} ${APIMAN})\r
  81 >  \r
  82 >  # Use the man page converter that is available. We should never depend\r
  83 >  # on MAN_ROFF_FILES if a converter is not available.\r
  84 > @@ -59,16 +61,24 @@ else\r
  85 >  build-man: ${MAN_GZIP_FILES}\r
  86 >  install-man: ${MAN_GZIP_FILES}\r
  87 >       mkdir -p "$(DESTDIR)$(mandir)/man1"\r
  88 > +     mkdir -p "$(DESTDIR)$(mandir)/man3"\r
  89 >       mkdir -p "$(DESTDIR)$(mandir)/man5"\r
  90 >       mkdir -p "$(DESTDIR)$(mandir)/man7"\r
  91 >       install -m0644 $(DOCBUILDDIR)/man/man1/*.1.gz $(DESTDIR)/$(mandir)/man1\r
  92 > +     install -m0644 $(DOCBUILDDIR)/man/man3/*.3.gz $(DESTDIR)/$(mandir)/man3\r
  93 >       install -m0644 $(DOCBUILDDIR)/man/man5/*.5.gz $(DESTDIR)/$(mandir)/man5\r
  94 >       install -m0644 $(DOCBUILDDIR)/man/man7/*.7.gz $(DESTDIR)/$(mandir)/man7\r
  95 >       cd $(DESTDIR)/$(mandir)/man1 && ln -sf notmuch.1.gz notmuch-setup.1.gz\r
  96 >  endif\r
  97 >  \r
  98 > +$(APIMAN): $(dir)/version.dox $(dir)/doxygen.cfg $(srcdir)/lib/notmuch.h\r
  99 > +     doxygen $(DOXYFILE)\r
 100 > +\r
 101 > +$(dir)/version.dox: $(srcdir)/version\r
 102 > +     sed -e 's/^/PROJECT_NAME = \"Notmuch /' -e 's/$$/\"/' < $< > $@\r
 103 > +\r
 104 \r
 105 LGTM, although:\r
 106 \r
 107       echo "PROJECT_NAME = \"Notmuch `cat $<`\"" >$@\r
 108 \r
 109 no, \r
 110 \r
 111       echo 'PROJECT_NAME = "Notmuch $(VERSION)"' > $@\r
 112 \r
 113 \r
 114 ... and, the dependency should be to version.stamp (w/o $(srcdir)) after\r
 115 \r
 116 id:1395261431-24668-1b-git-send-email-tomi.ollila@iki.fi is merged :D\r
 117 \r
 118 ... as especially developers need to know the exact version they have\r
 119 in their git tree instead of last released one.\r
 120 \r
 121 I marked my patch in this thread obsolete (my previous statement makes this\r
 122 obvious) and 1/1 on this series ready.\r
 123 \r
 124 Tomi\r
 125 \r
 126 \r
 127 \r
 128 >  $(dir)/docdeps.mk: $(dir)/conf.py $(dir)/mkdocdeps.py\r
 129 >       $(mkdocdeps) $(srcdir)/doc $(DOCBUILDDIR) $@\r
 130 >  \r
 131 >  CLEAN := $(CLEAN) $(DOCBUILDDIR) $(dir)/docdeps.mk $(dir)/man.stamp\r
 132 > -CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES)\r
 133 > +CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/version.dox\r
 134 > diff --git a/doc/doxygen.cfg b/doc/doxygen.cfg\r
 135 > index 65d5fb5..bf9f075 100644\r
 136 > --- a/doc/doxygen.cfg\r
 137 > +++ b/doc/doxygen.cfg\r
 138 > @@ -4,11 +4,11 @@\r
 139 >  # Project related configuration options\r
 140 >  #---------------------------------------------------------------------------\r
 141 >  DOXYFILE_ENCODING      = UTF-8\r
 142 > -PROJECT_NAME           = "Notmuch 0.17"\r
 143 > +@INCLUDE            =  "doc/version.dox"\r
 144 >  PROJECT_NUMBER         =\r
 145 >  PROJECT_BRIEF          =\r
 146 >  PROJECT_LOGO           =\r
 147 > -OUTPUT_DIRECTORY       =\r
 148 > +OUTPUT_DIRECTORY       = doc/_build\r
 149 >  CREATE_SUBDIRS         = NO\r
 150 >  OUTPUT_LANGUAGE        = English\r
 151 >  BRIEF_MEMBER_DESC      = YES\r
 152 > -- \r
 153 > 1.9.0\r