Re: [PATCHv2 2/3] revisions.txt: structure with a labelled list

From: Junio C Hamano <gitster@pobox.com>
Date: Apr 3, 2011, 19:01 UTC
Message-ID: <7vvcyvcg6o.fsf@alter.siamese.dyndns.org>
In-Reply-To: <b37095f8802face1fc7920359cf2db3536a5d3a2.1301649867.git.git@drmicha.warpmail.net>

Michael J Gruber <git@drmicha.warpmail.net> writes:

> -* The special construct '@\{-<n>\}' means the <n>th branch checked out
> +'@\{-<n>\}', e.g. '@\{-1\}'::
> +  The special construct '@\{-<n>\}' means the <n>th branch checked out
>    before the current one.

This is outside the scope of this patch, but there is nothing _special_ about @{-<n>} at all. When it appeared it might have been special but not anymore. We should reserve the word "special" only for "special" cases.

e.g. this one is perfectly fine:

Show 7 quoted lines

> +'<rev>{caret}', e.g. 'HEAD{caret}, v1.5.1{caret}0'::
> +  A suffix '{caret}' to a revision parameter means the first parent of
>    that commit object.  '{caret}<n>' means the <n>th parent (i.e.
> +  '<rev>{caret}'
> +  is equivalent to '<rev>{caret}1').  As a special rule,
> +  '<rev>{caret}0' means the commit itself and is used when '<rev>' is the
>    object name of a tag object that refers to a commit object.

A^1, A^2,..., A^$n all all parents of A; A^0 is not a parent of A but we still accept it as a special rule.