Re: [PATCH] doc: build man pages at build time, not install
authorJani Nikula <jani@nikula.org>
Mon, 10 Mar 2014 17:10:27 +0000 (19:10 +0200)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:00:34 +0000 (10:00 -0800)
9a/e15d133f8e7331c7caec921bcbae81bf20b209 [new file with mode: 0644]

diff --git a/9a/e15d133f8e7331c7caec921bcbae81bf20b209 b/9a/e15d133f8e7331c7caec921bcbae81bf20b209
new file mode 100644 (file)
index 0000000..4f0cd81
--- /dev/null
@@ -0,0 +1,136 @@
+Return-Path: <jani@nikula.org>\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 256BB431FBD\r
+       for <notmuch@notmuchmail.org>; Mon, 10 Mar 2014 10:10:41 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7] 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 amRXs8506vUa for <notmuch@notmuchmail.org>;\r
+       Mon, 10 Mar 2014 10:10:33 -0700 (PDT)\r
+Received: from mail-lb0-f172.google.com (mail-lb0-f172.google.com\r
+       [209.85.217.172]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 978E3431FBC\r
+       for <notmuch@notmuchmail.org>; Mon, 10 Mar 2014 10:10:33 -0700 (PDT)\r
+Received: by mail-lb0-f172.google.com with SMTP id c11so4810706lbj.17\r
+       for <notmuch@notmuchmail.org>; Mon, 10 Mar 2014 10:10:30 -0700 (PDT)\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+       d=1e100.net; s=20130820;\r
+       h=x-gm-message-state:from:to:subject:in-reply-to:references\r
+       :user-agent:date:message-id:mime-version:content-type;\r
+       bh=uBwF8psJMzb++wBQm+RbXUQ3UE3C3d7VNgxd3fySjHc=;\r
+       b=Koxfij0XilP42yruAIMZ0dJ0eUcm+bxb0rRE25KiIaQEUGCKZXPrlhNLmojgmyRuSt\r
+       2UkoPiRzxRFGYI7meeVMVUwf/B39dUWu/YIF/i6olPwpVtxrdMQvEXwhHADf6eaeETMf\r
+       g2sxtB4E1cErWOxgQGMQ6v5GcUiIgogscek34DfC+0e/hp9dTxASB2x0XPLC3G+bYK+x\r
+       1x5dycnWrU3rmPO3Rp+O2zVMILkFMFPDNlntxQQIbbJD1Cd9LJRW094RnWIGwrPcAyh/\r
+       v7X2yMYdpRL9Nlcn4LK6a02Yx0Kt8eqjnqnSLjn1nEz7T4CqbUdVcEqbn92pnHjeqShn\r
+       1S/w==\r
+X-Gm-Message-State:\r
+ ALoCoQnim7MPKRClk6en73Yv7iih/GiA1Le8detWg8WDSQ61pwCFE7zVH0hcBImBQjL9IZytCgv4\r
+X-Received: by 10.112.22.196 with SMTP id g4mr2289865lbf.47.1394471430686;\r
+       Mon, 10 Mar 2014 10:10:30 -0700 (PDT)\r
+Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi.\r
+       [88.195.111.91])\r
+       by mx.google.com with ESMTPSA id qx7sm22246001lbb.9.2014.03.10.10.10.28\r
+       for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Mon, 10 Mar 2014 10:10:29 -0700 (PDT)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH] doc: build man pages at build time, not install\r
+In-Reply-To: <1394449633-14737-1-git-send-email-david@tethera.net>\r
+References: <1394449633-14737-1-git-send-email-david@tethera.net>\r
+User-Agent: Notmuch/0.17+120~gb12e1244e14f (http://notmuchmail.org)\r
+       Emacs/24.3.1 (x86_64-pc-linux-gnu)\r
+Date: Mon, 10 Mar 2014 19:10:27 +0200\r
+Message-ID: <87y50ij7y4.fsf@nikula.org>\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: Mon, 10 Mar 2014 17:10:41 -0000\r
+\r
+On Mon, 10 Mar 2014, David Bremner <david@tethera.net> wrote:\r
+> This helps avoid build artifacts (namely, nroff and gzipped-nroff man\r
+> pages) owned by root.\r
+> ---\r
+>  Makefile.local     | 2 +-\r
+>  doc/Makefile.local | 6 ++++--\r
+>  2 files changed, 5 insertions(+), 3 deletions(-)\r
+>\r
+> diff --git a/Makefile.local b/Makefile.local\r
+> index 5f797ad..cb7b106 100644\r
+> --- a/Makefile.local\r
+> +++ b/Makefile.local\r
+> @@ -53,7 +53,7 @@ endif\r
+>  FINAL_LIBNOTMUCH_LDFLAGS = $(LDFLAGS) $(AS_NEEDED_LDFLAGS) $(CONFIGURE_LDFLAGS)\r
+>  \r
+>  .PHONY: all\r
+> -all: notmuch notmuch-shared\r
+> +all: notmuch notmuch-shared build-man\r
+>  ifeq ($(MAKECMDGOALS),)\r
+>  ifeq ($(shell cat .first-build-message 2>/dev/null),)\r
+>      @NOTMUCH_FIRST_BUILD=1 $(MAKE) --no-print-directory all\r
+> diff --git a/doc/Makefile.local b/doc/Makefile.local\r
+> index fd64f70..5be49dc 100644\r
+> --- a/doc/Makefile.local\r
+> +++ b/doc/Makefile.local\r
+> @@ -16,7 +16,7 @@ ALLSPHINXOPTS   := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(dir)\r
+>  .PHONY: sphinx-html sphinx-man sphinx-texinfo sphinx-info\r
+>  .PHONY: rst2man\r
+>  \r
+> -.PHONY: install-man\r
+> +.PHONY: install-man build-man\r
+>  \r
+>  %.gz: %\r
+>      rm -f $@ && gzip --stdout $^ > $@\r
+> @@ -43,7 +43,9 @@ MAN_GZIP_FILES := $(addsuffix .gz,${MAN_ROFF_FILES})\r
+>  \r
+>  ${MAN_ROFF_FILES} : sphinx-man\r
+>  \r
+> -install-man: ${MAN_GZIP_FILES}\r
+> +build-man: ${MAN_GZIP_FILES}\r
+> +\r
+> +install-man: build-man\r
+\r
+Because build-man is a .PHONY target, it'll get done also on\r
+install-man, and one still ends up with root owned files on 'sudo make\r
+install'. The improvement to previous is that doc/_build/man directory\r
+is now created in the build phase and the files can be removed by the\r
+regular user.\r
+\r
+An actual non-phony dependency chain from .gz to man page to rst would\r
+be awesome, but I don't know how hard it would be with the\r
+sphinx/rst2man targets.\r
+\r
+BR,\r
+Jani.\r
+\r
+\r
+>      mkdir -p "$(DESTDIR)$(mandir)/man1"\r
+>      mkdir -p "$(DESTDIR)$(mandir)/man5"\r
+>      mkdir -p "$(DESTDIR)$(mandir)/man7"\r
+> -- \r
+> 1.8.5.3\r
+>\r
+> _______________________________________________\r
+> notmuch mailing list\r
+> notmuch@notmuchmail.org\r
+> http://notmuchmail.org/mailman/listinfo/notmuch\r