git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] revisions.txt: mention <rev>~ form

From
Andreas Heiduk <asheiduk@gmail.com>
Date
Apr 26, 2019, 20:55 UTC
Message-ID
<1d84c3bc-4e18-450e-edc6-96ac34f61c7a@gmail.com>
In-Reply-To
<18c8ed70602271a28c93df922eb3da8fb7563e2e.1555913472.git.liu.denton@gmail.com>
Am 22.04.19 um 08:12 schrieb Denton Liu:
Show 24 quoted lines
> In revisions.txt, the '<rev>^' form is mentioned but the '<rev>~' form
> is missing. Although both forms are essentially equivalent (they each
> get the first parent of the specified revision), we should mention the
> latter for completeness. Make this change.
> 
> While we're at it, the brief form of '<rev>^' makes it seem as if no
> numerical argument is accepted. Update documentation to make it obvious
> that an optional numerical argument is accepted.
> 
> Signed-off-by: Denton Liu <liu.denton@gmail.com>
> ---
>  Documentation/revisions.txt | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
> index 2337a995ec..4ba7b4416a 100644
> --- a/Documentation/revisions.txt
> +++ b/Documentation/revisions.txt
> @@ -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'::
This
Show 9 quoted lines
>    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}'
> @@ -139,7 +139,9 @@ thing no matter the case.
>    '<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.
>  
> -'<rev>{tilde}<n>', e.g. 'master{tilde}3'::
> +'<rev>{tilde}[<n>]', e.g. 'HEAD~, master{tilde}3'::

and here: These would be the first and only places in revisions.txt where [] denote optional syntax. Since *exactly* this place is already riddled with special characters wich are either part of the syntax (e.g. @, {}) or not (e.g. <n>) this would be confusing.

In other places of the file optional syntax is *displayed* like this:
       <branchname>@{upstream}, e.g. master@{upstream}, @{u}
in that spirit somethind like this:
	<rev>~<n>', e.g. 'HEAD~, master~3', master~
would be better to read.
Show 5 quoted lines
> +  A suffix '{tilde}' to a revision parameter means the first parent of
> +  that commit object.
>    A suffix '{tilde}<n>' to a revision parameter means the commit
>    object that is the <n>th generation ancestor of the named
>    commit object, following only the first parents.  I.e. '<rev>{tilde}3' is
Previous: Junio C HamanoNext: Denton Liu
Message 7 of 16 in “revisions.txt: mention <rev>~ form”
  1. revisions.txt: mention <rev>~ formDenton Liu, Apr 22, 2019
  2. Junio C HamanoApr 22, 2019
  3. Denton LiuApr 22, 2019
  4. Junio C HamanoApr 22, 2019
  5. Duy NguyenApr 22, 2019
  6. Junio C HamanoApr 24, 2019
  7. Andreas HeidukApr 26, 2019
  8. Denton LiuApr 26, 2019
  9. 0/3 cleanup revisions.txtDenton Liu, Apr 27, 2019
  10. 1/3 revisions.txt: change "rev" to "<rev>"Denton Liu, Apr 27, 2019
  11. 2/3 revisions.txt: mark optional rev arguments with []Denton Liu, Apr 27, 2019
  12. Andreas HeidukMay 3, 2019
  13. Andreas HeidukMay 3, 2019
  14. 3/3 revisions.txt: mention <rev>~ formDenton Liu, Apr 27, 2019
  15. Andreas HeidukMay 3, 2019
  16. Denton LiuMay 3, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.