list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <>
To: Taylor Blau <>
Cc: Noam Yorav-Raphael via GitGitGadget <>,, Noam Yorav-Raphael <>
Subject: Re: [PATCH] docs: improve the example that illustrates git-notes path names
Date: Mon, 03 Aug 2020 10:04:15 -0700	[thread overview]
Message-ID: <> (raw)
In-Reply-To: <20200803154852.GA48612@syl.lan> (Taylor Blau's message of "Mon, 3 Aug 2020 11:48:52 -0400")

Taylor Blau <> writes:

>> diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
>> index ced2e8280e..9fc1979531 100644
>> --- a/Documentation/git-notes.txt
>> +++ b/Documentation/git-notes.txt
>> @@ -223,7 +223,7 @@ are taken from notes refs.  A notes ref is usually a branch which
>>  contains "files" whose paths are the object names for the objects
>>  they describe, with some directory separators included for performance
>>  reasons footnote:[Permitted pathnames have the form
>> -'ab'`/`'cd'`/`'ef'`/`'...'`/`'abcdef...': a sequence of directory
>> +'12'`/`'34'`/`'56'`/`'...'`/`'789abc...': a sequence of directory
> I had to read this twice to figure out why the first 'ab' changed to
> '12'. It appears that this is to avoid having to use 'gh...' in the
> last directory, since 'g', 'h' and so on aren't hexadecimal digits.

You can wrap-around to '0' after counting up to 'f', no ;-)?

Having '/.../' between '56' and '789' to indicate "there are more
levels possible here" is somewhat misleading with the new example.
We could argue that the original objectname does not have to be
"123456789abc.." but then the whole exercise becomes somewhat
pointless as the objectname could have been 'abcdef...abcdef...'.

Another minor nit: it probably makes it read more natural to start
counting from '0' when writing hexadecimal, if we really want to
use sequence of ascending hexdigits.

Using a seemingly random example 85/b4/.../808d9ee6debdf167ced3
might be less confusing, because ...

>>  names of two hexadecimal digits each followed by a filename with the
>>  rest of the object ID.].

... I think these two lines is pleanty clear than any example, so I
am OK with either the old or the updated example, but I think a
seemingly random example as long as the leaf level does not share
the leading hexdigits as the pathname would work the best.

  reply	other threads:[~2020-08-03 17:04 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-03 14:43 Noam Yorav-Raphael via GitGitGadget
2020-08-03 15:48 ` Taylor Blau
2020-08-03 17:04   ` Junio C Hamano [this message]
2020-08-03 17:13     ` Taylor Blau
2020-08-03 16:21 ` [PATCH v2] " Noam Yorav-Raphael via GitGitGadget
2020-08-03 16:31   ` Taylor Blau
2020-08-03 19:10   ` [PATCH v3] " Noam Yorav-Raphael via GitGitGadget
2020-08-03 19:11     ` Taylor Blau
2020-08-03 19:39       ` 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:

  List information:

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

  git send-email \ \ \ \ \ \ \
    --subject='Re: [PATCH] docs: improve the example that illustrates git-notes path names' \

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this inbox:

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).