Git Mailing List Archive mirror
 help / color / mirror / Atom feed
From: Sean Allred <allred.sean@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Sean Allred via GitGitGadget <gitgitgadget@gmail.com>,
	git@vger.kernel.org, Eric Sunshine <sunshine@sunshineco.com>,
	Sean Allred <allred.sean@gmail.com>,
	Sean Allred <code@seanallred.com>
Subject: Re: [PATCH v3 6/6] ls-remote doc: document the output format
Date: Thu, 18 May 2023 23:04:07 -0500	[thread overview]
Message-ID: <m0y1llt133.fsf@epic96565.epic.com> (raw)
In-Reply-To: <xmqqfs7x8iu4.fsf@gitster.g>


Junio C Hamano <gitster@pobox.com> writes:
>> +OUTPUT
>> +------
>> +
>> +The output is in the format:
>> +
>> +------------
>> +<oid> TAB <ref> LF
>> +------------
>> +
>> +When `<ref>` is a tag, it may be followed by `^{}` to show its peeled
>> +representation.
>
> While I can guess what the above wants to say, the above does not
> quite "click" for me for some reason.  Here is my attempt.
>
>     When showing an annotated tag, unless `--refs` is given, two
>     such lines are shown, one with the refname for the tag itself as
>     <ref>, and another with <ref> followed by `^{}`.  The `<oid>` on
>     the latter line shows the name of the object the tag points at.

This is clear to me, too (even reading it late at night -- kudos), so
I've adopted your suggestion verbatim with a few minor formatting nits.
Thanks!

> The verb `peel` is used in the explanation for the `--refs` option,
> but there is no formal definition of what it means in the glossary.
>
> We may want to do something about it, but we probably would want to
> leave it outside the scope of this series.

I'll add a tracking task for myself to potentially address this in the
coming week or two, but I'll be happily surprised if someone else beats
me to it :-) I agree it's out of scope for this series.

--
Sean Allred

  reply	other threads:[~2023-05-19  4:08 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-18 15:33 [PATCH] Document the output format of ls-remote Sean Allred via GitGitGadget
2023-03-19 17:30 ` Eric Sunshine
2023-03-19 19:25   ` Felipe Contreras
2023-03-19 21:36   ` Sean Allred
2023-03-22  9:49 ` [PATCH v2 0/2] " Sean Allred via GitGitGadget
2023-03-22  9:49   ` [PATCH v2 1/2] Update show-ref documentation for internal consistency Sean Allred via GitGitGadget
2023-03-22 16:50     ` Junio C Hamano
2023-03-22  9:49   ` [PATCH v2 2/2] Document the output format of ls-remote Sean Allred via GitGitGadget
2023-03-22 16:48     ` Junio C Hamano
2023-03-22 17:13       ` Re* " Junio C Hamano
2023-05-15 12:13   ` [PATCH v3 0/6] " Sean Allred via GitGitGadget
2023-05-15 12:13     ` [PATCH v3 1/6] show-ref doc: update for internal consistency Sean Allred via GitGitGadget
2023-05-15 16:58       ` Eric Sunshine
2023-05-15 17:27         ` Junio C Hamano
2023-05-19  3:51           ` Sean Allred
2023-05-15 19:48       ` Junio C Hamano
2023-05-19  3:55         ` Sean Allred
2023-05-15 12:13     ` [PATCH v3 2/6] show-branch doc: say <ref>, not <reference> Junio C Hamano via GitGitGadget
2023-05-15 12:13     ` [PATCH v3 3/6] ls-remote doc: remove redundant --tags example Sean Allred via GitGitGadget
2023-05-15 19:52       ` Junio C Hamano
2023-05-15 12:13     ` [PATCH v3 4/6] ls-remote doc: show peeled tags in examples Sean Allred via GitGitGadget
2023-05-15 19:53       ` Junio C Hamano
2023-05-15 12:13     ` [PATCH v3 5/6] ls-remote doc: explain what each example does Sean Allred via GitGitGadget
2023-05-15 12:13     ` [PATCH v3 6/6] ls-remote doc: document the output format Sean Allred via GitGitGadget
2023-05-15 20:01       ` Junio C Hamano
2023-05-19  4:04         ` Sean Allred [this message]
2023-05-19  4:17     ` [PATCH v4 0/6] Document the output format of ls-remote Sean Allred via GitGitGadget
2023-05-19  4:17       ` [PATCH v4 1/6] show-ref doc: update for internal consistency Sean Allred via GitGitGadget
2023-05-19  4:17       ` [PATCH v4 2/6] show-branch doc: say <ref>, not <reference> Junio C Hamano via GitGitGadget
2023-05-19  4:17       ` [PATCH v4 3/6] ls-remote doc: remove redundant --tags example Sean Allred via GitGitGadget
2023-05-19  4:17       ` [PATCH v4 4/6] ls-remote doc: show peeled tags in examples Sean Allred via GitGitGadget
2023-05-19  4:17       ` [PATCH v4 5/6] ls-remote doc: explain what each example does Sean Allred via GitGitGadget
2023-05-19  4:17       ` [PATCH v4 6/6] ls-remote doc: document the output format Sean Allred via GitGitGadget

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=m0y1llt133.fsf@epic96565.epic.com \
    --to=allred.sean@gmail.com \
    --cc=code@seanallred.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=gitster@pobox.com \
    --cc=sunshine@sunshineco.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.
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).