From: "Philip Oakley" <philipoakley@iee.org>
To: "Ann T Ropea" <bedhanger@gmx.de>, "Junio C Hamano" <gitster@pobox.com>
Cc: "Git Mailing List" <git@vger.kernel.org>,
"Daniel Barkalow" <barkalow@iabervon.org>,
"Ann T Ropea" <bedhanger@gmx.de>
Subject: Re: [PATCH 1/3] checkout: describe_detached_head: remove 3dots after committish
Date: Tue, 7 Nov 2017 23:25:02 -0000 [thread overview]
Message-ID: <83D263E58ABD46188756D41FE311E469@PhilipOakley> (raw)
In-Reply-To: 20171107025321.31028-1-bedhanger@gmx.de
From: "Ann T Ropea" <bedhanger@gmx.de>
> Thanks for all the feedback provided!
>
> I'd like to summarise what consensus we have reached so far and
> then propose a way forward:
>
> * we'll use the term "ellipsis (pl. ellipses)" for what's
> been referred to as "3dots", "n-dots", "many dots" and so
> forth
Using a consistent term for the *display* of shortened oid's is good.
>
> * we would like to use ellipses when attached to SHA-1
> values only for the purpose of specifying a symmetric
> difference (as per gitrevisions(7))
The symetric difference (three-dots) is a specific Git *cli* notation that
is distinct from the use of ellipsis for displaying oid's
>
> * the usage of ellipses as a "here we truncated something
> longer" is a relic which should be phased out.
I think that is true.
>
> To get there, preventing describe_detached_head from appending
> an ellipsis to the SHA-1 values it prints is one important step.
>
> This change does not cause any test to fall over.
But...
>
> The other important step is dealing with the "git diff --raw"
> output which features ellipses in the relic-fashion no longer
> desired.
>
> It would appear that simplifying diff.c's diff_aligned_abbrev
> routine to something like:
>
> /* Do we want all 40 hex characters?
> */
> if (len == GIT_SHA1_HEXSZ)
> return oid_to_hex(oid);
>
> /* An abbreviated value is fine.
> */
> return diff_abbrev_oid(oid, len);
>
> does do the trick.
>
> This change causes quite a few tests to fall over; however, they
> all have truncated-something-longer-ellipses in their
> raw-diff-output expected sections, and removing the ellipses
> from there makes the tests pass again, :-)
The number of failures you report in the test suit suggests that someone
somewhere will be expecting that notation, and that we may need a
deprecation period, perhaps with an 'ellipsis' config variable whose default
value can later be flipped, though that leaves a config value needing
support forever!
Junio should be able to better advise on his preferred approach.
>
> If we can agree that this is a way forward, i'll create & send
> v2 of the patch series to the mailing list (it'll include the
> fixed tests) and we'll see where we go from there.
--
Philip
next prev parent reply other threads:[~2017-11-07 23:25 UTC|newest]
Thread overview: 58+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-11-05 16:27 [PATCH 1/3] checkout: describe_detached_head: remove 3dots after committish Ann T Ropea
2017-11-05 16:27 ` [PATCH 2/3] Documentation: user-manual: limit potentially confusing usage of 3dots (and 2dots) Ann T Ropea
2017-11-05 16:27 ` [PATCH 3/3] Documentation: revisions: add note about 3dots usages as continuation indications Ann T Ropea
2017-11-06 4:34 ` Junio C Hamano
2017-11-06 2:45 ` [PATCH 1/3] checkout: describe_detached_head: remove 3dots after committish Junio C Hamano
2017-11-07 0:30 ` Philip Oakley
2017-11-07 0:52 ` Junio C Hamano
2017-11-07 2:53 ` Ann T Ropea
2017-11-07 23:25 ` Philip Oakley [this message]
2017-11-08 1:59 ` Junio C Hamano
2017-11-09 23:15 ` Philip Oakley
2017-11-13 22:36 ` [PATCH v2 1/6] config: introduce core.printsha1ellipsis Ann T Ropea
2017-11-13 22:36 ` [PATCH v2 2/6] checkout: describe_detached_head: remove ellipsis after committish Ann T Ropea
2017-11-13 22:36 ` [PATCH v2 3/6] diff: diff_aligned_abbrev: remove ellipsis after abbreviated SHA-1 value Ann T Ropea
2017-11-14 3:08 ` Junio C Hamano
2017-11-19 17:38 ` Ann T Ropea
2017-11-20 1:48 ` Junio C Hamano
2017-11-19 18:41 ` [PATCH v3 1/5] checkout: describe_detached_head: remove ellipsis after committish Ann T Ropea
2017-11-20 3:35 ` Junio C Hamano
2017-11-19 18:41 ` [PATCH v3 2/5] diff: diff_aligned_abbrev: remove ellipsis after abbreviated SHA-1 value Ann T Ropea
2017-11-19 19:11 ` Eric Sunshine
2017-11-19 18:41 ` [PATCH v3 3/5] Documentation: user-manual: limit usage of ellipsis Ann T Ropea
2017-11-19 19:15 ` Eric Sunshine
2017-11-24 23:53 ` [PATCH v4 1/6] diff: diff_aligned_abbrev: remove ellipsis after abbreviated SHA-1 value Ann T Ropea
2017-11-25 5:01 ` Junio C Hamano
2017-11-26 3:17 ` Junio C Hamano
2017-11-26 3:19 ` Junio C Hamano
2017-11-26 3:25 ` Junio C Hamano
2017-12-03 21:27 ` [PATCH v5 1/7] Documentation: revisions: fix typo: "three dot" ---> "three-dot" (in line with "two-dot") Ann T Ropea
2017-12-04 16:52 ` Junio C Hamano
2017-12-03 21:27 ` [PATCH v5 2/7] Documentation: user-manual: limit usage of ellipsis Ann T Ropea
2017-12-03 21:27 ` [PATCH v5 3/7] print_sha1_ellipsis: introduce helper Ann T Ropea
2017-12-03 21:27 ` [PATCH v5 4/7] checkout: describe_detached_head: remove ellipsis after committish Ann T Ropea
2017-12-04 16:46 ` Junio C Hamano
2017-12-04 23:13 ` [PATCH v6 " Ann T Ropea
2017-12-05 16:03 ` Junio C Hamano
2017-12-06 0:20 ` [PATCH v7 " Ann T Ropea
2017-12-06 16:47 ` Junio C Hamano
2017-12-06 22:02 ` Ann T Ropea
2017-12-03 21:27 ` [PATCH v5 5/7] t4013: prepare for upcoming "diff --raw --abbrev" output format change Ann T Ropea
2017-12-03 21:27 ` [PATCH v5 6/7] diff: diff_aligned_abbrev: remove ellipsis after abbreviated SHA-1 value Ann T Ropea
2017-12-03 21:27 ` [PATCH v5 7/7] t4013: test new output from diff --abbrev --raw Ann T Ropea
2017-11-24 23:53 ` [PATCH v4 2/6] checkout: describe_detached_head: remove ellipsis after committish Ann T Ropea
2017-11-24 23:53 ` [PATCH v4 3/6] Documentation: user-manual: limit usage of ellipsis Ann T Ropea
2017-11-24 23:53 ` [PATCH v4 4/6] Documentation: revisions: fix typo: "three dot" ---> "three-dot" (in line with "two-dot") Ann T Ropea
2017-11-24 23:53 ` [PATCH v4 5/6] Documentation: git: document GIT_PRINT_SHA1_ELLIPSIS Ann T Ropea
2017-11-24 23:53 ` [PATCH v4 6/6] Testing: provide existing tests requiring them with ellipses after SHA-1 values Ann T Ropea
2017-11-19 18:41 ` [PATCH v3 4/5] Documentation: revisions: fix typo: "three dot" ---> "three-dot" (in line with "two-dot") Ann T Ropea
2017-11-19 18:41 ` [PATCH v3 5/5] Testing: provide tests requiring them with ellipses after SHA-1 values Ann T Ropea
2017-11-20 4:06 ` Junio C Hamano
2017-11-20 12:25 ` Philip Oakley
2017-11-22 5:53 ` Junio C Hamano
2017-11-22 23:41 ` Philip Oakley
2017-11-24 0:40 ` Junio C Hamano
2017-11-13 22:36 ` [PATCH v2 4/6] Documentation: user-manual: limit usage of ellipsis Ann T Ropea
2017-11-13 22:36 ` [PATCH v2 5/6] Documentation: revisions: fix typo: "three dot" ---> "three-dot" (in line with "two-dot") Ann T Ropea
2017-11-13 22:36 ` [PATCH v2 6/6] Testing: provide tests requiring them with ellipses after SHA-1 values Ann T Ropea
2017-11-14 3:20 ` 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=83D263E58ABD46188756D41FE311E469@PhilipOakley \
--to=philipoakley@iee.org \
--cc=barkalow@iabervon.org \
--cc=bedhanger@gmx.de \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.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).