From: Jeff King <peff@peff.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] Allow generating a non-default set of documentation
Date: Sun, 7 Oct 2012 17:48:56 -0400 [thread overview]
Message-ID: <20121007214855.GB1743@sigill.intra.peff.net> (raw)
In-Reply-To: <7vzk3yow3f.fsf@alter.siamese.dyndns.org>
On Sun, Oct 07, 2012 at 01:39:32PM -0700, Junio C Hamano wrote:
> By default, "make doc" generates the manpages and htmldocs in the
> Documentation directory, but you may want to change this depending
> on the target environment, e.g. to include 'pdf'. Introduce a new
> Makefile variable DEFAULT_DOC_TARGET to allow customizing this.
Makes sense (we have DEFAULT_TEST_TARGET for similar reasons).
> The primary motivation is to let us check documentation patches with
>
> $ DEFAULT_DOC_TARGET=git-push.1 make doc
Wouldn't it be just as easy to say:
$ make -C Documentation git-push.1
?
> but it is not so far-fetched to imagine that Windows users may want to
> omit manpages with
>
> $ DEFAULT_DOC_TARGET=html make doc
That use case makes a lot more sense to me (or more likely setting it in
config.mak).
> Makefile | 12 ++++++++++--
> 1 file changed, 10 insertions(+), 2 deletions(-)
No change to Documentation/Makefile? So this will work:
$ echo DEFAULT_DOC_TARGET=html >config.mak
$ make doc
but this will not:
$ cd Documentation
$ make
Why not do it like this:
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 267dfe1..ca10313 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -152,7 +152,8 @@ endif
endif
endif
-all: html man
+DEFAULT_DOC_TARGET ?= html man
+all: $(DEFAULT_DOC_TARGET)
html: $(DOC_HTML)
which covers both cases? That is also how we handle DEFAULT_TEST_TARGET.
-Peff
next prev parent reply other threads:[~2012-10-07 21:49 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-10-07 20:39 [PATCH] Allow generating a non-default set of documentation Junio C Hamano
2012-10-07 21:48 ` Jeff King [this message]
2012-10-07 22:32 ` Junio C Hamano
2012-10-07 22:45 ` Junio C Hamano
2012-10-07 23:01 ` Jeff King
2012-10-07 22:40 ` Junio C Hamano
2012-10-07 23:07 ` Jeff King
2012-10-07 23:11 ` Jeff King
2012-10-07 23:25 ` Junio C Hamano
2012-10-07 23:29 ` Jeff King
2012-10-07 23:44 ` Junio C Hamano
2012-10-08 16:33 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20121007214855.GB1743@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).