Re: [PATCH] builtin-branch - allow deleting a fully specified branch-name

From: Junio C Hamano <gitster@pobox.com>
Date: Apr 12, 2009, 08:22 UTC
Message-ID: <7v7i1qb7sw.fsf@gitster.siamese.dyndns.org>
In-Reply-To: <20090412072056.GA25837@coredump.intra.peff.net>

Jeff King <peff@peff.net> writes:

Show 7 quoted lines

> And I can see why you might think of it that way, because that is what
> the synopsis in git-checkout(1) says. :) But it is really:
>
>   git checkout -b <branch> <commit>
>
> I'm not sure if changing that synopsis would really help, or if it is
> a bit too subtle.

I think in many places we used to be stricter in terminology (e.g. when we only need tree-ish we used to write tree-ish) but during the "usability and approachiablility drive" people updated doc with "most of the time the command takes commit, so we say commit".

I think "the apporachable part" aka "synopsis" should be kept the way it is, but we should clarify in the description when the most general form is different from the white lie we feed to newbies.