git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Michael J Gruber <michaeljgruber+gmane@fastmail.fm>
To: Junio C Hamano <gitster@pobox.com>
Cc: Bert Wesarg <bert.wesarg@googlemail.com>,
	Josef 'Jeff' Sipek <jeffpc@josefsipek.net>,
	Git Mailing List <git@vger.kernel.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	guilt@lists.josefsipek.net, Brandon Philips <brandon@ifup.org>
Subject: Re: [ANNOUNCE] Guilt v0.31
Date: Tue, 09 Sep 2008 17:40:15 +0200	[thread overview]
Message-ID: <48C698DF.7010401@fastmail.fm> (raw)
In-Reply-To: <7vd4jd8i9b.fsf@gitster.siamese.dyndns.org>

Junio C Hamano venit, vidit, dixit 09.09.2008 17:13:
> Michael J Gruber <michaeljgruber+gmane@fastmail.fm> writes:
> 
>> I would go about renaming quick-install-doc to quick-install-man, introducing quick-install-html doing the analogous using the "html" branch and quick-install-doc doing both, which would be more in line with the install-doc target.
>>
>> Are there any objections to renaming quick-install-doc to quick-install-man?
> 
> What does it improve?

It makes it more systematic.

Right now:

Documentation/Makefile:
all: builds html and man
install: installs only man (depends on man)
install-{info,html}: installs $foo (depends on $foo)
quick-install: installs man from man branch

Makefile:
doc: builds html and man (-C D all)
install-doc: installs only man (-C D install)
install-{info,html}: installs $foo (-C D install-$foo)
quick-install-doc: installs man from man branch (-C D install-$foo)

So there is a distinct asymmetry between build targets and install
targets. Wouldn't you expect "make install" to install what "make"
builds? That is true, but "make install-doc" doesn't install what "make
doc" builds.

Put it differently:
doc = man + html for build targets
doc = man for install targets

What's worse: "make doc" fails if you don't have xmlto, even though
"make install-doc" may succeed; but you'll never try it when the build
fails. Until a few hours ago I thought I couldn't build man pages at
work (asciidoc, but no xmlto), and I had never heard about
quick-install-doc until I looked at the Makefiles in detail.

> IOW, can't you do what you want to do (I am assuming that what you want to
> do is to be able to copy out the pregenerated contents from convenience
> branches) without such a rename?

Sure I can. "Namen sind Schall und Rauch". Names don't matter.
quick-install-html would follow the above logic. I just think that the
doc logic is flawed.

So, my suggestion is that doc = man + html, whether it appears in a
build target or an install target.

> If you rename the target, I am reasonably sure you would break somebody's
> build procedure.  It is a separate topic if there are large number of such
> somebody, or just a limited few.

I keep hearing this argument, and I'm even more surprised to hear it
right after a major release. If not now then when's a good time for
cleaning up confusing inconsistencies?

Michael

  reply	other threads:[~2008-09-09 15:41 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-09-08 13:52 [ANNOUNCE] Guilt v0.31 Josef 'Jeff' Sipek
2008-09-08 15:39 ` Michael J Gruber
2008-09-08 15:45   ` Josef 'Jeff' Sipek
2008-09-08 15:58   ` Josef 'Jeff' Sipek
2008-09-08 18:33 ` Bert Wesarg
2008-09-08 18:43   ` Josef 'Jeff' Sipek
2008-09-08 18:50     ` Bert Wesarg
2008-09-08 19:17       ` Junio C Hamano
2008-09-09 10:10         ` Michael J Gruber
2008-09-09 13:02           ` Michael J Gruber
2008-09-09 15:13             ` Junio C Hamano
2008-09-09 15:40               ` Michael J Gruber [this message]
2008-09-09 16:02                 ` Junio C Hamano
2008-09-09 16:29                   ` Michael J Gruber

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=48C698DF.7010401@fastmail.fm \
    --to=michaeljgruber+gmane@fastmail.fm \
    --cc=bert.wesarg@googlemail.com \
    --cc=brandon@ifup.org \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=guilt@lists.josefsipek.net \
    --cc=jeffpc@josefsipek.net \
    --cc=linux-kernel@vger.kernel.org \
    /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.
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 NNTP newsgroup(s).