From: Junio C Hamano <gitster@pobox.com>
To: Carlo Arenas <carenas@gmail.com>
Cc: Bagas Sanjaya <bagasdotme@gmail.com>,
git@vger.kernel.org, tbperrotta@gmail.com, avarab@gmail.com
Subject: Re: [RFC PATCH] Documentation: better document format-patch options in send-email
Date: Sun, 10 Oct 2021 14:33:28 -0700 [thread overview]
Message-ID: <xmqq1r4sftuf.fsf@gitster.g> (raw)
In-Reply-To: <CAPUEsphrNMPO_KaAmae02-DsxB9m1tBEK_Gnv29_mLQn0j2MkA@mail.gmail.com> (Carlo Arenas's message of "Sat, 9 Oct 2021 02:32:42 -0700")
Carlo Arenas <carenas@gmail.com> writes:
>> > +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 from the
>> > +beginning of history up until <commit>, use the `--root` option:
>> > +`git format-patch --root <commit>`.
>>
>> Supposed that we have following commit graph:
>>
>> a --- b --- c --- d --- e --- f (main)
>> \
>> --- g --- h --- i (mywork, HEAD)
>>
>> According to your edit, `git format-patch <c>` and `git format-patch
>> --root <i>` are equivalent, right?
>
> I didn't change the definition of --root with my edit, but I guess it
> is still confusing.
The explanation you gave Bagas describes what these two variants,
i.e. "<c> alone" and "--root <c>", mean and how they behave very
clearly. In fact, the 4-line description is designed to encourage
readers to compare a pair of cases like these, using the same commit
in the middle of the history you get two quite different set of
commits with and without "--root".
You can ask for "--root <i>" to get a-b-c-g-h-i but it is not
a good example as there is no useful contrasting example that does
not use "--root", as "git format-patch i" would be showing an empty
set.
The fact that somebody wanted to compare between "<c>" and "--root
<i>" might be a sign that the 4-line description is still somehow
confusing, but I cannot quite figure out what needs to be improved
in the description to avoid such a confusion (IOW, I fail to see how
the description can lead to such a confusion).
Thanks.
next prev parent reply other threads:[~2021-10-10 21:33 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 [this message]
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
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=xmqq1r4sftuf.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).