Am 03.05.19 um 09:17 schrieb Andreas Heiduk:
> Am 27.04.19 um 14:16 schrieb Denton Liu:
>> In revisions.txt, an optional rev argument was not distinguised.
>> Instead, a user had to continue and read the description in order to
>> learn that the argument was optional.
>>
>> Since the [] notation for an optional argument is common-knowledge in
>> the Git documentation, mark optional arguments with [] so that it's more
>> obvious for the reader.
>>
>> Signed-off-by: Denton Liu <[email protected]>
>> ---
>> Documentation/revisions.txt | 6 +++---
>> 1 file changed, 3 insertions(+), 3 deletions(-)
>>
>> diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
>> index e5f11691b1..68cce2ca06 100644
>> --- a/Documentation/revisions.txt
>> +++ b/Documentation/revisions.txt
>
> I think I found another one here:
>
> @@ -65,7 +65,7 @@ some output processing may assume ref names in UTF-8.
> '@'::
> '@' alone is a shortcut for `HEAD`.
>
> -'<refname>@{<date>}', e.g. 'master@\{yesterday\}', 'HEAD@{5 minutes ago}'::
> +'[<refname>]@{<date>}', e.g. 'master@\{yesterday\}', 'HEAD@{5 minutes ago}'::
> A ref followed by the suffix '@' with a date specification
> enclosed in a brace
> pair (e.g. '\{yesterday\}', '{1 month 2 weeks 3 days 1 hour 1
>
> The doesn't give a hint that <refname> is optional but actually it is.
>
>> @@ -95,7 +95,7 @@ some output processing may assume ref names in UTF-8.
>> The construct '@{-<n>}' means the <n>th branch/commit checked out
>> before the current one.
>>
>> -'<branchname>@\{upstream\}', e.g. 'master@\{upstream\}', '@\{u\}'::
>> +'[<branchname>]@\{upstream\}', e.g. 'master@\{upstream\}', '@\{u\}'::
>> The suffix '@\{upstream\}' to a branchname (short form
>> '<branchname>@\{u\}')
>> refers to the branch that the branch specified by branchname is set to
>> build on
>> top of (configured with `branch.<name>.remote` and
>> @@ -103,7 +103,7 @@ some output processing may assume ref names in UTF-8.
>> current one. These suffixes are also accepted when spelled in uppercase,
>> and
>> they mean the same thing no matter the case.
>>
>> -'<branchname>@\{push\}', e.g. 'master@\{push\}', '@\{push\}'::
>> +'[<branchname>]@\{push\}', e.g. 'master@\{push\}', '@\{push\}'::
>> The suffix '@\{push}' reports the branch "where we would push to" if
>> `git push` were run while `branchname` was checked out (or the current
>> `HEAD` if no branchname is specified). Since our push destination is
>> @@ -131,7 +131,7 @@ from one location and push to another. In a
>> non-triangular workflow,
>> This suffix is also accepted when spelled in uppercase, and means the same
>> thing no matter the case.
>>
>> -'<rev>{caret}', e.g. 'HEAD{caret}, v1.5.1{caret}0'::
>> +'<rev>{caret}[<n>]', 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}'
>
And another one I've found after hitting "Send" :-(
@@ -346,7 +346,7 @@ Revision Range Summary
as giving commit '<rev>' and then all its parents prefixed with
'{caret}' to exclude them (and their ancestors).
-'<rev>{caret}-<n>', e.g. 'HEAD{caret}-, HEAD{caret}-2'::
+'<rev>{caret}-[<n>]', e.g. 'HEAD{caret}-, HEAD{caret}-2'::
Equivalent to '<rev>{caret}<n>..<rev>', with '<n>' = 1 if not
given.
