From: Andreas Heiduk <asheiduk@gmail.com>
To: Denton Liu <liu.denton@gmail.com>,
Git Mailing List <git@vger.kernel.org>
Subject: Re: [PATCH] revisions.txt: mention <rev>~ form
Date: Fri, 26 Apr 2019 22:55:35 +0200 [thread overview]
Message-ID: <1d84c3bc-4e18-450e-edc6-96ac34f61c7a@gmail.com> (raw)
In-Reply-To: <18c8ed70602271a28c93df922eb3da8fb7563e2e.1555913472.git.liu.denton@gmail.com>
Am 22.04.19 um 08:12 schrieb Denton Liu:
> 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
> 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.
> + 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
next prev parent reply other threads:[~2019-04-26 20:55 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-22 6:12 [PATCH] revisions.txt: mention <rev>~ form Denton Liu
2019-04-22 6:32 ` Junio C Hamano
2019-04-22 7:39 ` Denton Liu
2019-04-22 11:21 ` Junio C Hamano
2019-04-22 9:59 ` Duy Nguyen
2019-04-24 1:05 ` Junio C Hamano
2019-04-26 20:55 ` Andreas Heiduk [this message]
2019-04-26 21:16 ` Denton Liu
2019-04-27 12:15 ` [PATCH v2 0/3] cleanup revisions.txt Denton Liu
2019-04-27 12:15 ` [PATCH v2 1/3] revisions.txt: change "rev" to "<rev>" Denton Liu
2019-04-27 12:16 ` [PATCH v2 2/3] revisions.txt: mark optional rev arguments with [] Denton Liu
2019-05-03 7:17 ` Andreas Heiduk
2019-05-03 7:35 ` Andreas Heiduk
2019-04-27 12:16 ` [PATCH v2 3/3] revisions.txt: mention <rev>~ form Denton Liu
2019-05-03 8:01 ` [PATCH v2 0/3] cleanup revisions.txt Andreas Heiduk
2019-05-03 8:13 ` Denton Liu
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1d84c3bc-4e18-450e-edc6-96ac34f61c7a@gmail.com \
--to=asheiduk@gmail.com \
--cc=git@vger.kernel.org \
--cc=liu.denton@gmail.com \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).