From: Junio C Hamano <gitster@pobox.com>
To: Stefan Beller <sbeller@google.com>
Cc: Jonathan Tan <jonathantanmy@google.com>, git <git@vger.kernel.org>
Subject: Re: [PATCHv4 7/7] builtin/describe.c: describe a blob
Date: Thu, 16 Nov 2017 10:43:43 +0900 [thread overview]
Message-ID: <xmqq7eurxak0.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <CAGZ79kaum5py=14kdFy1a+K_0MzfaD5boYStixh=1aY2tUCV-Q@mail.gmail.com> (Stefan Beller's message of "Wed, 15 Nov 2017 17:22:51 -0800")
Stefan Beller <sbeller@google.com> writes:
>>> -git-describe - Describe a commit using the most recent tag reachable from it
>>> +git-describe - Describe a commit or blob using the graph relations
>>
>> I would write "Describe a commit or blob using a tag reachable from it".
>
> using a ref, as we also can use refs.
> I think 'the graph' is technically correct here, but may be too confusing.
Without saying graph over what, "graph relations" is not just
confusing but an insufficient explanation for a technically correct
explanation. Even though we have "--contains", we say "reachable from"
and nobody has complained---so perhaps we can keep the white lie to
keep the synopsis simpler?
If I were writing this sentence from scratch, perhaps I wouldn't
even use the word "describe". How about
Give an object a human readable name based on an available ref
or something like that?
>> (Should we also test the case where a blob is directly
>> tagged?)
>
> We do a bad job at describing tags that point at a blob currently:
>
> git tag test-blob HEAD:Makefile
> git describe test-blob
> error: object cd75985991f4535c45e2589222a9e6a38fb1d613 is a blob, not a commit
> fatal: test-blob is not a valid 'commit' object
>
> This series changes this to
>
> git describe test-blob
> v2.15.0-rc0-43-g54bd705a95:Makefile
>
> which might not be expected (you'd expect "test-blob"),
> so I think I can write a test telling that this is suboptimal
> behavior?
Or a sentence in BUGS section.
A case (or two) I find more interesting is to see how the code
behaves against these:
git tag -a -m "annotated blob" a-blob HEAD:Makefile
git tag -a -m "annotated tree" a-tree HEAD:t
git describe a-blob a-tree
Thanks.
next prev parent reply other threads:[~2017-11-16 1:43 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-11-15 0:30 [PATCHv4 0/7] describe a blob Stefan Beller
2017-11-15 0:30 ` [PATCHv4 1/7] t6120: fix typo in test name Stefan Beller
2017-11-15 0:30 ` [PATCHv4 2/7] list-objects.c: factor out traverse_trees_and_blobs Stefan Beller
2017-11-15 0:30 ` [PATCHv4 3/7] revision.h: introduce blob/tree walking in order of the commits Stefan Beller
2017-11-15 1:38 ` Jonathan Tan
2017-11-15 0:30 ` [PATCHv4 4/7] builtin/describe.c: rename `oid` to avoid variable shadowing Stefan Beller
2017-11-15 0:30 ` [PATCHv4 5/7] builtin/describe.c: print debug statements earlier Stefan Beller
2017-11-15 1:41 ` Jonathan Tan
2017-11-15 0:30 ` [PATCHv4 6/7] builtin/describe.c: factor out describe_commit Stefan Beller
2017-11-15 1:44 ` Jonathan Tan
2017-11-15 0:30 ` [PATCHv4 7/7] builtin/describe.c: describe a blob Stefan Beller
2017-11-15 1:52 ` Jonathan Tan
2017-11-16 1:22 ` Stefan Beller
2017-11-16 1:43 ` Junio C Hamano [this message]
2017-11-16 1:49 ` Stefan Beller
2017-11-16 2:04 ` Junio C Hamano
2017-11-17 1:06 ` 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=xmqq7eurxak0.fsf@gitster.mtv.corp.google.com \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=jonathantanmy@google.com \
--cc=sbeller@google.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).