From: Denton Liu <liu.denton@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: "Duy Nguyen" <pclouds@gmail.com>,
"Git Mailing List" <git@vger.kernel.org>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Andreas Schwab" <schwab@linux-m68k.org>,
"Elijah Newren" <newren@gmail.com>,
"Johannes Schindelin" <Johannes.Schindelin@gmx.de>,
"Johannes Sixt" <j6t@kdbg.org>,
"Philip Oakley" <philipoakley@iee.org>,
"Vincent Guittot" <vincent.guittot@linaro.org>,
"Viresh Kumar" <viresh.kumar@linaro.org>
Subject: Re: [PATCH] git-diff.txt: prefer not using <commit>..<commit>
Date: Mon, 18 Mar 2019 18:12:17 -0700 [thread overview]
Message-ID: <20190319011217.GA20393@dev-l> (raw)
In-Reply-To: <xmqq5zsg3cl6.fsf@gitster-ct.c.googlers.com>
On Mon, Mar 18, 2019 at 03:45:25PM +0900, Junio C Hamano wrote:
> Duy Nguyen <pclouds@gmail.com> writes:
>
> >> - This is synonymous to the previous form. If <commit> on
> >> + This is synonymous to the previous form. However,
> >> + users should prefer the previous form over this form
> >> + as this form may be more confusing due to the same
> >> + notation having a logically conflicting meaning in
> >> + linkgit:git-rev-list[1]-ish commands. If <commit> on
> >> one side is omitted, it will have the same effect as
> >> using HEAD instead.
> >
> > This is fine as-is. But another option to reduce even more exposure of
> > these forms (both <commit>..[<commit>] and <commit>...[<commit>]) is
> > to delete these forms in "DESCRIPTION" section and add maybe "EXOTIC
> > SYNTAX" (or something) section after "OPTIONS" for just them.
>
> There is no other way to express A...B (well, short of spelling it
> out as "$(git merge-base A B) B"), so while it makes quite a lot of
> sense to discourage A..B (simply because .. is unnecessary and can
> be replace with a string with one fewer letter in it, namely " "),
> I am not sure if it is wise to throw the three-dot form into the
> same basket.
>
Perhaps we could add an option to use the base as a comparison,
something like "git diff --compare-base A B" which would mean
"git diff $(git merge-base A B) B".
If we do this, we could keep feature-parity while deprecating the
confusing "range-notation" for diff. Then, we could possibly move .. and
... into a "RANGE-BASED SYNTAX" section and call it a day.
I now personally don't think that deprecating it in the code (or even
adding a warning) would be worth the effort since the syntax is so
ingrained in common usage. However, I believe that we should encourage
new users to avoid the range-syntax if possible.
next prev parent reply other threads:[~2019-03-19 1:12 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-03-17 11:09 [PATCH] git-diff.txt: prefer not using <commit>..<commit> Denton Liu
2019-03-17 13:24 ` Duy Nguyen
2019-03-18 6:45 ` Junio C Hamano
2019-03-19 1:12 ` Denton Liu [this message]
2019-03-21 14:12 ` Johannes Schindelin
2019-03-17 13:40 ` Ævar Arnfjörð Bjarmason
2019-03-17 14:01 ` Duy Nguyen
2019-03-17 14:12 ` Ævar Arnfjörð Bjarmason
2019-03-18 6:47 ` Junio C Hamano
2019-03-18 17:46 ` Elijah Newren
2019-03-18 19:07 ` Ævar Arnfjörð Bjarmason
2019-03-19 0:56 ` Junio C Hamano
2019-03-20 14:21 ` Elijah Newren
2019-03-18 17:59 ` Elijah Newren
2019-03-20 17:28 ` Denton Liu
2019-03-21 13:58 ` Elijah Newren
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=20190319011217.GA20393@dev-l \
--to=liu.denton@gmail.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=j6t@kdbg.org \
--cc=newren@gmail.com \
--cc=pclouds@gmail.com \
--cc=philipoakley@iee.org \
--cc=schwab@linux-m68k.org \
--cc=vincent.guittot@linaro.org \
--cc=viresh.kumar@linaro.org \
/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).