From: Junio C Hamano <gitster@pobox.com>
To: "Carlo Marcelo Arenas Belón" <carenas@gmail.com>
Cc: Bagas Sanjaya <bagasdotme@gmail.com>,
Thiago Perrotta <tbperrotta@gmail.com>,
avarab@gmail.com, git@vger.kernel.org
Subject: Re: [PATCH v5 3/3] send-email docs: add format-patch options
Date: Wed, 29 Sep 2021 14:20:31 -0700 [thread overview]
Message-ID: <xmqqpmsrcc4g.fsf@gitster.g> (raw)
In-Reply-To: <YU6+BWC+xvGJP3b0@carlos-mbp.lan> ("Carlo Marcelo Arenas Belón"'s message of "Fri, 24 Sep 2021 23:13:25 -0700")
Carlo Marcelo Arenas Belón <carenas@gmail.com> writes:
>> Everything after "git format-patch", i.e. -2, master, master..HEAD,
>> are usable, and there isn't much point in singling out revision
>> ranges. FWIW, I think you can even give "-- <pathspec>" at the end,
>> which are not options or revision ranges.
>
> <format-patch options> then it is; would the following be worth adding
> in top so the recursive reference can be followed?
I am not sure what "the recursive reference" is an issue here, but
I agree that we may want to improve upon <revision range> in the
part you are touching, which currently we say:
There are two ways to specify which commits to operate on.
1. A single commit, <since>, specifies that the commits leading
to the tip of the current branch that are not in the history
that leads to the <since> to be output.
2. Generic <revision range> expression (see "SPECIFYING
REVISIONS" section in linkgit:gitrevisions[7]) means the
commits in the specified range.
The first rule takes precedence in the case of a single <commit>. To
apply the second rule, i.e., format everything since the beginning of
history up until <commit>, use the `--root` option: `git format-patch
--root <commit>`. If you want to format only <commit> itself, you
can do this with `git format-patch -1 <commit>`.
What we refer to in the prose, e.g. "--root" and " -1", do not
appear in the SYNOPSIS section.
> diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
> index fe2f69d36e..806ff93259 100644
> --- a/Documentation/git-format-patch.txt
> +++ b/Documentation/git-format-patch.txt
> @@ -30,7 +30,7 @@ SYNOPSIS
> [--range-diff=<previous> [--creation-factor=<percent>]]
> [--filename-max-length=<n>]
> [--progress]
> - [<common diff options>]
> + [<common diff options>] [<rev-list options>]
> [ <since> | <revision range> ]
I think the "<rev-list options>" you are adding here is to enhance
what <revision range> in the original wants to convey. In addition
to things like @{u}..HEAD~2 (i.e. "the branch is mostly good, but
the tip 2 commits are not yet ready so do not send them out"), you
can do "-2" (i.e. "the topmost 2 commits"), which is not exactly
what "SPECIFYING REVISIONS" part of gitrevisions(7) describes.
So, yes, I like the spirit of the change, but no, I do not think it
goes there; rather, it would replace or extend <revision range>, I
would think.
In addition, "Generic <revision range> expression (see "SPECIFYING
REVISIONS" section...) may need to be updated. First, what we'd
want to refer to is not ways to specify revisions, but ways to
specify a range. IOW, it should be referring to "SPECIFYING RANGES"
section instead.
If we replace <revision range> with your <rev-list options> in the
SYNOPSIS, that will fall out as a natural consequence. Perhaps, the
second description and an earlier part of the explanation can be
rewritten like so:
2. <rev-list options> that specifies a range of commits (see
linkgit:git-rev-list[1]) to be shown.
If you give a single <commit> and nothing else, it is taken as
the <since> of the first form. If you want to format everything
since the beginning of history up until <commit>, use ...
Thanks.
next prev parent reply other threads:[~2021-09-29 21:20 UTC|newest]
Thread overview: 58+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-20 0:46 [PATCH v2 0/3] send-email: shell completion improvements Thiago Perrotta
2021-08-20 0:46 ` [PATCH v2 1/3] send-email: print newline for --git-completion-helper Thiago Perrotta
2021-08-20 20:17 ` Junio C Hamano
2021-08-28 3:08 ` [PATCH v3 0/3] send-email: shell completion improvements Thiago Perrotta
2021-08-28 3:08 ` [PATCH v3 1/3] send-email: terminate --git-completion-helper with LF Thiago Perrotta
2021-08-28 3:08 ` [PATCH v3 2/3] send-email: move bash completions to core script Thiago Perrotta
2021-08-28 5:25 ` Carlo Arenas
2021-09-07 0:16 ` [PATCH] " Thiago Perrotta
2021-09-07 1:28 ` Carlo Arenas
2021-09-21 15:51 ` [PATCH v4 0/3] send-email: shell completion improvements Thiago Perrotta
2021-09-21 15:51 ` [PATCH v4 1/3] send-email: terminate --git-completion-helper with LF Thiago Perrotta
2021-09-21 15:51 ` [PATCH v4 2/3] send-email: move bash completions to core script Thiago Perrotta
2021-09-21 15:51 ` [PATCH v4 3/3] send-email docs: add format-patch options Thiago Perrotta
2021-09-23 14:02 ` [PATCH v4 0/3] send-email: shell completion improvements Ævar Arnfjörð Bjarmason
2021-09-24 2:46 ` [PATCH v5 " Thiago Perrotta
2021-09-24 20:02 ` Ævar Arnfjörð Bjarmason
2021-09-30 3:10 ` Thiago Perrotta
2021-10-07 3:36 ` [PATCH v6 " Thiago Perrotta
2021-10-07 3:36 ` [PATCH v6 1/3] send-email: terminate --git-completion-helper with LF Thiago Perrotta
2021-10-07 3:36 ` [PATCH v6 2/3] send-email: programmatically generate bash completions Thiago Perrotta
2021-10-09 6:38 ` Carlo Marcelo Arenas Belón
2021-10-11 4:10 ` [PATCH v7 0/3] send-email: shell completion improvements Thiago Perrotta
2021-10-11 13:46 ` Ævar Arnfjörð Bjarmason
2021-10-11 17:12 ` [DRAFT/WIP PATCH] send-email: programmatically generate bash completions Thiago Perrotta
2021-10-25 21:27 ` [PATCH v8 0/2] send-email: shell completion improvements Thiago Perrotta
2021-10-25 22:44 ` Ævar Arnfjörð Bjarmason
2021-10-26 0:48 ` Ævar Arnfjörð Bjarmason
2021-10-28 16:31 ` Junio C Hamano
2021-10-25 21:27 ` [PATCH v8 1/2] send-email: programmatically generate bash completions Thiago Perrotta
2021-10-25 21:27 ` [PATCH v8 2/2] send-email docs: add format-patch options Thiago Perrotta
2021-10-11 4:10 ` [PATCH v7 1/3] send-email: terminate --git-completion-helper with LF Thiago Perrotta
2021-10-11 4:10 ` [PATCH v7 2/3] send-email: programmatically generate bash completions Thiago Perrotta
2021-10-11 4:10 ` [PATCH v7 3/3] send-email docs: add format-patch options Thiago Perrotta
2021-10-07 3:36 ` [PATCH v6 " Thiago Perrotta
2021-10-09 8:31 ` [RFC PATCH] Documentation: better document format-patch options in send-email Carlo Marcelo Arenas Belón
2021-10-09 8:57 ` Bagas Sanjaya
2021-10-09 9:32 ` Carlo Arenas
2021-10-09 11:04 ` Bagas Sanjaya
2021-10-10 21:33 ` Junio C Hamano
2021-09-24 2:46 ` [PATCH v5 1/3] send-email: terminate --git-completion-helper with LF Thiago Perrotta
2021-09-24 2:46 ` [PATCH v5 2/3] send-email: programmatically generate bash completions Thiago Perrotta
2021-09-24 2:46 ` [PATCH v5 3/3] send-email docs: add format-patch options Thiago Perrotta
2021-09-24 4:36 ` Bagas Sanjaya
2021-09-24 4:53 ` Carlo Arenas
2021-09-24 6:19 ` Bagas Sanjaya
2021-09-24 6:56 ` Carlo Arenas
2021-09-24 15:33 ` Junio C Hamano
2021-09-24 17:34 ` Carlo Arenas
2021-09-24 20:03 ` Junio C Hamano
2021-09-25 3:03 ` Bagas Sanjaya
2021-09-25 4:07 ` Junio C Hamano
2021-09-25 6:13 ` Carlo Marcelo Arenas Belón
2021-09-29 21:20 ` Junio C Hamano [this message]
2021-08-28 3:08 ` [PATCH v3 " Thiago Perrotta
2021-08-28 5:22 ` Bagas Sanjaya
2021-08-20 0:46 ` [PATCH v2 2/3] send-email: move bash completions to the perl script Thiago Perrotta
2021-08-20 0:46 ` [PATCH v2 3/3] send-email docs: mention format-patch options Thiago Perrotta
2021-08-20 20:32 ` Junio C Hamano
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=xmqqpmsrcc4g.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=avarab@gmail.com \
--cc=bagasdotme@gmail.com \
--cc=carenas@gmail.com \
--cc=git@vger.kernel.org \
--cc=tbperrotta@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).