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