git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
* [PATCH] docs: improve the example that illustrates git-notes path names
@ 2020-08-03 14:43 Noam Yorav-Raphael via GitGitGadget
  2020-08-03 15:48 ` Taylor Blau
  2020-08-03 16:21 ` [PATCH v2] " Noam Yorav-Raphael via GitGitGadget
  0 siblings, 2 replies; 9+ messages in thread
From: Noam Yorav-Raphael via GitGitGadget @ 2020-08-03 14:43 UTC (permalink / raw)
  To: git; +Cc: Noam Yorav-Raphael, Noam Yorav-Raphael

From: Noam Yorav-Raphael <noamraph@gmail.com>

The existing git-notes doc says:

> Permitted pathnames have the form ab/cd/ef/…​/abcdef…​: a sequence of
> directory names of two hexadecimal digits each followed by a filename
> with the rest of the object ID.

Even though the text says that the filename has the rest of the object ID,
I felt the need to check this, since the example gives the impression that
the filename is the entire object ID (a schema which is quite prevalent).

The new example makes it clear that the filename has only the rest of the
object ID, and not the entire object ID.

Signed-off-by: Noam Yorav-Raphael <noamraph@gmail.com>
---
    Improve the example that illustrates git-notes path names
    
    The existing git-notes doc says:
    
    > Permitted pathnames have the form ab/cd/ef/…​/abcdef…​: a sequence of
    > directory names of two hexadecimal digits each followed by a filename
    > with the rest of the object ID.
    
    Even though the text says that the filename has the rest of the object
    ID, I felt the need to check this, since the example gives the
    impression that the filename is the entire object ID (a schema which is
    quite prevalent).
    
    The new example makes it clear that the filename has only the rest of
    the object ID, and not the entire object ID.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-692%2Fnoamraph%2Fclearer-notes-path-doc-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-692/noamraph/clearer-notes-path-doc-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/692

 Documentation/git-notes.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

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
 names of two hexadecimal digits each followed by a filename with the
 rest of the object ID.].
 

base-commit: 85b4e0a6dc8407de6f69808d9ee6debdf167ced3
-- 
gitgitgadget

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [PATCH] docs: improve the example that illustrates git-notes path names
  2020-08-03 14:43 [PATCH] docs: improve the example that illustrates git-notes path names Noam Yorav-Raphael via GitGitGadget
@ 2020-08-03 15:48 ` Taylor Blau
  2020-08-03 17:04   ` Junio C Hamano
  2020-08-03 16:21 ` [PATCH v2] " Noam Yorav-Raphael via GitGitGadget
  1 sibling, 1 reply; 9+ messages in thread
From: Taylor Blau @ 2020-08-03 15:48 UTC (permalink / raw)
  To: Noam Yorav-Raphael via GitGitGadget; +Cc: git, Noam Yorav-Raphael

On Mon, Aug 03, 2020 at 02:43:36PM +0000, Noam Yorav-Raphael via GitGitGadget wrote:
> From: Noam Yorav-Raphael <noamraph@gmail.com>
>
> The existing git-notes doc says:
>
> > Permitted pathnames have the form ab/cd/ef/…​/abcdef…​: a sequence of
> > directory names of two hexadecimal digits each followed by a filename
> > with the rest of the object ID.

This part of the commit message is unnecessary, since it can easily be
read off from the diff.

>
> Even though the text says that the filename has the rest of the object ID,
> I felt the need to check this, since the example gives the impression that
> the filename is the entire object ID (a schema which is quite prevalent).
>
> The new example makes it clear that the filename has only the rest of the
> object ID, and not the entire object ID.

Please use the imperative mood here. Instead of the above, consider:

  Make it clear that the filename has only the rest of the object ID,
  not the entirety of it.

> Signed-off-by: Noam Yorav-Raphael <noamraph@gmail.com>
> ---
>     Improve the example that illustrates git-notes path names
>
>     The existing git-notes doc says:
>
>     > Permitted pathnames have the form ab/cd/ef/…​/abcdef…​: a sequence of
>     > directory names of two hexadecimal digits each followed by a filename
>     > with the rest of the object ID.
>
>     Even though the text says that the filename has the rest of the object
>     ID, I felt the need to check this, since the example gives the
>     impression that the filename is the entire object ID (a schema which is
>     quite prevalent).
>
>     The new example makes it clear that the filename has only the rest of
>     the object ID, and not the entire object ID.
>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-692%2Fnoamraph%2Fclearer-notes-path-doc-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-692/noamraph/clearer-notes-path-doc-v1
> Pull-Request: https://github.com/gitgitgadget/git/pull/692
>
>  Documentation/git-notes.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> 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.

Makes sense.

>  names of two hexadecimal digits each followed by a filename with the
>  rest of the object ID.].
>
>
> base-commit: 85b4e0a6dc8407de6f69808d9ee6debdf167ced3
> --
> gitgitgadget

The patch looks fine, but the commit message needs some tweaking.
Thanks.

Thanks,
Taylor

^ permalink raw reply	[flat|nested] 9+ messages in thread

* [PATCH v2] docs: improve the example that illustrates git-notes path names
  2020-08-03 14:43 [PATCH] docs: improve the example that illustrates git-notes path names Noam Yorav-Raphael via GitGitGadget
  2020-08-03 15:48 ` Taylor Blau
@ 2020-08-03 16:21 ` Noam Yorav-Raphael via GitGitGadget
  2020-08-03 16:31   ` Taylor Blau
  2020-08-03 19:10   ` [PATCH v3] " Noam Yorav-Raphael via GitGitGadget
  1 sibling, 2 replies; 9+ messages in thread
From: Noam Yorav-Raphael via GitGitGadget @ 2020-08-03 16:21 UTC (permalink / raw)
  To: git; +Cc: Noam Yorav-Raphael, Noam Yorav-Raphael

From: Noam Yorav-Raphael <noamraph@gmail.com>

Make it clear that the filename has only the rest of the object ID,
not the entirety of it.

Signed-off-by: Noam Yorav-Raphael <noamraph@gmail.com>
---
    Improve the example that illustrates git-notes path names
    
    docs: improve the example that illustrates git-notes path names
    
    Make it clear that the filename has only the rest of the object ID, not
    the entirety of it.
    
    Changed: improved the commit message, according to comments by Taylor
    Blau.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-692%2Fnoamraph%2Fclearer-notes-path-doc-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-692/noamraph/clearer-notes-path-doc-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/692

Range-diff vs v1:

 1:  76a674871a ! 1:  8b3defb657 docs: improve the example that illustrates git-notes path names
     @@ Metadata
       ## Commit message ##
          docs: improve the example that illustrates git-notes path names
      
     -    The existing git-notes doc says:
     -
     -    > Permitted pathnames have the form ab/cd/ef/…​/abcdef…​: a sequence of
     -    > directory names of two hexadecimal digits each followed by a filename
     -    > with the rest of the object ID.
     -
     -    Even though the text says that the filename has the rest of the object ID,
     -    I felt the need to check this, since the example gives the impression that
     -    the filename is the entire object ID (a schema which is quite prevalent).
     -
     -    The new example makes it clear that the filename has only the rest of the
     -    object ID, and not the entire object ID.
     +    Make it clear that the filename has only the rest of the object ID,
     +    not the entirety of it.
      
          Signed-off-by: Noam Yorav-Raphael <noamraph@gmail.com>
      


 Documentation/git-notes.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

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
 names of two hexadecimal digits each followed by a filename with the
 rest of the object ID.].
 

base-commit: 85b4e0a6dc8407de6f69808d9ee6debdf167ced3
-- 
gitgitgadget

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [PATCH v2] docs: improve the example that illustrates git-notes path names
  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
  1 sibling, 0 replies; 9+ messages in thread
From: Taylor Blau @ 2020-08-03 16:31 UTC (permalink / raw)
  To: Noam Yorav-Raphael via GitGitGadget; +Cc: git, Noam Yorav-Raphael

Hi Noam,

On Mon, Aug 03, 2020 at 04:21:16PM +0000, Noam Yorav-Raphael via GitGitGadget wrote:
> From: Noam Yorav-Raphael <noamraph@gmail.com>
>
> Make it clear that the filename has only the rest of the object ID,
> not the entirety of it.

This looks great, thank you. I left one note below, but I don't think
that you should feel obligated to address it.

> Signed-off-by: Noam Yorav-Raphael <noamraph@gmail.com>
> ---
>     Improve the example that illustrates git-notes path names
>
>     docs: improve the example that illustrates git-notes path names
>
>     Make it clear that the filename has only the rest of the object ID, not
>     the entirety of it.
>
>     Changed: improved the commit message, according to comments by Taylor
>     Blau.
>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-692%2Fnoamraph%2Fclearer-notes-path-doc-v2
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-692/noamraph/clearer-notes-path-doc-v2
> Pull-Request: https://github.com/gitgitgadget/git/pull/692
>
> Range-diff vs v1:
>
>  1:  76a674871a ! 1:  8b3defb657 docs: improve the example that illustrates git-notes path names
>      @@ Metadata
>        ## Commit message ##
>           docs: improve the example that illustrates git-notes path names
>
>      -    The existing git-notes doc says:
>      -
>      -    > Permitted pathnames have the form ab/cd/ef/…​/abcdef…​: a sequence of
>      -    > directory names of two hexadecimal digits each followed by a filename
>      -    > with the rest of the object ID.
>      -
>      -    Even though the text says that the filename has the rest of the object ID,
>      -    I felt the need to check this, since the example gives the impression that
>      -    the filename is the entire object ID (a schema which is quite prevalent).
>      -
>      -    The new example makes it clear that the filename has only the rest of the
>      -    object ID, and not the entire object ID.
>      +    Make it clear that the filename has only the rest of the object ID,
>      +    not the entirety of it.
>
>           Signed-off-by: Noam Yorav-Raphael <noamraph@gmail.com>
>
>
>
>  Documentation/git-notes.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> 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

Sorry for not suggesting this earlier, but I think you could just as
easily start this with '01' instead of '12'. I don't think that it
matters, though, the point that you're trying to illustrate is perfectly
clear.

>  names of two hexadecimal digits each followed by a filename with the
>  rest of the object ID.].
>
>
> base-commit: 85b4e0a6dc8407de6f69808d9ee6debdf167ced3
> --
> gitgitgadget

  Reviewed-by: Taylor Blau <me@ttaylorr.com>

Thanks,
Taylor

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [PATCH] docs: improve the example that illustrates git-notes path names
  2020-08-03 15:48 ` Taylor Blau
@ 2020-08-03 17:04   ` Junio C Hamano
  2020-08-03 17:13     ` Taylor Blau
  0 siblings, 1 reply; 9+ messages in thread
From: Junio C Hamano @ 2020-08-03 17:04 UTC (permalink / raw)
  To: Taylor Blau; +Cc: Noam Yorav-Raphael via GitGitGadget, git, Noam Yorav-Raphael

Taylor Blau <me@ttaylorr.com> 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.


^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [PATCH] docs: improve the example that illustrates git-notes path names
  2020-08-03 17:04   ` Junio C Hamano
@ 2020-08-03 17:13     ` Taylor Blau
  0 siblings, 0 replies; 9+ messages in thread
From: Taylor Blau @ 2020-08-03 17:13 UTC (permalink / raw)
  To: Junio C Hamano
  Cc: Taylor Blau, Noam Yorav-Raphael via GitGitGadget, git,
	Noam Yorav-Raphael

On Mon, Aug 03, 2020 at 10:04:15AM -0700, Junio C Hamano wrote:
> Taylor Blau <me@ttaylorr.com> 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.

I agree with your reasoning (it didn't occur to me as a problem before,
but seeing it spelled out in front of me I could understand how such an
example might be confusing).

Thanks,
Taylor

^ permalink raw reply	[flat|nested] 9+ messages in thread

* [PATCH v3] docs: improve the example that illustrates git-notes path names
  2020-08-03 16:21 ` [PATCH v2] " Noam Yorav-Raphael via GitGitGadget
  2020-08-03 16:31   ` Taylor Blau
@ 2020-08-03 19:10   ` Noam Yorav-Raphael via GitGitGadget
  2020-08-03 19:11     ` Taylor Blau
  1 sibling, 1 reply; 9+ messages in thread
From: Noam Yorav-Raphael via GitGitGadget @ 2020-08-03 19:10 UTC (permalink / raw)
  To: git; +Cc: Noam Yorav-Raphael, Noam Yorav-Raphael

From: Noam Yorav-Raphael <noamraph@gmail.com>

Make it clear that the filename has only the rest of the object ID,
not the entirety of it.

Signed-off-by: Noam Yorav-Raphael <noamraph@gmail.com>
---
    Improve the example that illustrates git-notes path names
    
    docs: improve the example that illustrates git-notes path names
    
    Make it clear that the filename has only the rest of the object ID, not
    the entirety of it.
    
    Changes since v1:
    
     * Improved the commit message, according to comments by Taylor Blau.
     * Changed the parts to random hex, so the '...' won't be confusing,
       according to suggestion by Junio C Hamano.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-692%2Fnoamraph%2Fclearer-notes-path-doc-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-692/noamraph/clearer-notes-path-doc-v3
Pull-Request: https://github.com/gitgitgadget/git/pull/692

Range-diff vs v2:

 1:  8b3defb657 ! 1:  e973e321d8 docs: improve the example that illustrates git-notes path names
     @@ Documentation/git-notes.txt: are taken from notes refs.  A notes ref is usually
       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
     ++'bf'`/`'fe'`/`'30'`/`'...'`/`'680d5a...': a sequence of directory
       names of two hexadecimal digits each followed by a filename with the
       rest of the object ID.].
       


 Documentation/git-notes.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index ced2e8280e..0a4200674c 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
+'bf'`/`'fe'`/`'30'`/`'...'`/`'680d5a...': a sequence of directory
 names of two hexadecimal digits each followed by a filename with the
 rest of the object ID.].
 

base-commit: 85b4e0a6dc8407de6f69808d9ee6debdf167ced3
-- 
gitgitgadget

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [PATCH v3] docs: improve the example that illustrates git-notes path names
  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
  0 siblings, 1 reply; 9+ messages in thread
From: Taylor Blau @ 2020-08-03 19:11 UTC (permalink / raw)
  To: Noam Yorav-Raphael via GitGitGadget; +Cc: git, Noam Yorav-Raphael

On Mon, Aug 03, 2020 at 07:10:15PM +0000, Noam Yorav-Raphael via GitGitGadget wrote:
> From: Noam Yorav-Raphael <noamraph@gmail.com>
>
> Make it clear that the filename has only the rest of the object ID,
> not the entirety of it.
>
> Signed-off-by: Noam Yorav-Raphael <noamraph@gmail.com>
> ---
>     Improve the example that illustrates git-notes path names
>
>     docs: improve the example that illustrates git-notes path names
>
>     Make it clear that the filename has only the rest of the object ID, not
>     the entirety of it.
>
>     Changes since v1:
>
>      * Improved the commit message, according to comments by Taylor Blau.
>      * Changed the parts to random hex, so the '...' won't be confusing,
>        according to suggestion by Junio C Hamano.
>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-692%2Fnoamraph%2Fclearer-notes-path-doc-v3
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-692/noamraph/clearer-notes-path-doc-v3
> Pull-Request: https://github.com/gitgitgadget/git/pull/692
>
> Range-diff vs v2:
>
>  1:  8b3defb657 ! 1:  e973e321d8 docs: improve the example that illustrates git-notes path names
>      @@ Documentation/git-notes.txt: are taken from notes refs.  A notes ref is usually
>        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
>      ++'bf'`/`'fe'`/`'30'`/`'...'`/`'680d5a...': a sequence of directory
>        names of two hexadecimal digits each followed by a filename with the
>        rest of the object ID.].
>
>
>
>  Documentation/git-notes.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
> index ced2e8280e..0a4200674c 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
> +'bf'`/`'fe'`/`'30'`/`'...'`/`'680d5a...': a sequence of directory
>  names of two hexadecimal digits each followed by a filename with the
>  rest of the object ID.].
>
>
> base-commit: 85b4e0a6dc8407de6f69808d9ee6debdf167ced3
> --
> gitgitgadget

Looks good to me, but Junio should chime in, too.

  Acked-by: Taylor Blau <me@ttaylorr.com>

Thanks,
Taylor

^ permalink raw reply	[flat|nested] 9+ messages in thread

* Re: [PATCH v3] docs: improve the example that illustrates git-notes path names
  2020-08-03 19:11     ` Taylor Blau
@ 2020-08-03 19:39       ` Junio C Hamano
  0 siblings, 0 replies; 9+ messages in thread
From: Junio C Hamano @ 2020-08-03 19:39 UTC (permalink / raw)
  To: Taylor Blau; +Cc: Noam Yorav-Raphael via GitGitGadget, git, Noam Yorav-Raphael

Taylor Blau <me@ttaylorr.com> writes:

> On Mon, Aug 03, 2020 at 07:10:15PM +0000, Noam Yorav-Raphael via GitGitGadget wrote:
>> From: Noam Yorav-Raphael <noamraph@gmail.com>
>>
>> Make it clear that the filename has only the rest of the object ID,
>> not the entirety of it.
>>
>> Signed-off-by: Noam Yorav-Raphael <noamraph@gmail.com>
>> ---
>>     Improve the example that illustrates git-notes path names
>>
>>     docs: improve the example that illustrates git-notes path names
>>
>>     Make it clear that the filename has only the rest of the object ID, not
>>     the entirety of it.
>>
>>     Changes since v1:
>>
>>      * Improved the commit message, according to comments by Taylor Blau.
>>      * Changed the parts to random hex, so the '...' won't be confusing,
>>        according to suggestion by Junio C Hamano.
>>
>> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-692%2Fnoamraph%2Fclearer-notes-path-doc-v3
>> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-692/noamraph/clearer-notes-path-doc-v3
>> Pull-Request: https://github.com/gitgitgadget/git/pull/692
>>
>> Range-diff vs v2:
>>
>>  1:  8b3defb657 ! 1:  e973e321d8 docs: improve the example that illustrates git-notes path names
>>      @@ Documentation/git-notes.txt: are taken from notes refs.  A notes ref is usually
>>        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
>>      ++'bf'`/`'fe'`/`'30'`/`'...'`/`'680d5a...': a sequence of directory
>>        names of two hexadecimal digits each followed by a filename with the
>>        rest of the object ID.].
>>
>>
>>
>>  Documentation/git-notes.txt | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
>> index ced2e8280e..0a4200674c 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
>> +'bf'`/`'fe'`/`'30'`/`'...'`/`'680d5a...': a sequence of directory
>>  names of two hexadecimal digits each followed by a filename with the
>>  rest of the object ID.].
>>
>>
>> base-commit: 85b4e0a6dc8407de6f69808d9ee6debdf167ced3
>> --
>> gitgitgadget
>
> Looks good to me, but Junio should chime in, too.
>
>   Acked-by: Taylor Blau <me@ttaylorr.com>

Yeah, thanks, both.

^ permalink raw reply	[flat|nested] 9+ messages in thread

end of thread, other threads:[~2020-08-03 19:39 UTC | newest]

Thread overview: 9+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-08-03 14:43 [PATCH] docs: improve the example that illustrates git-notes path names Noam Yorav-Raphael via GitGitGadget
2020-08-03 15:48 ` Taylor Blau
2020-08-03 17:04   ` Junio C Hamano
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

Code repositories for project(s) associated with this 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).