[v2] docs: improve the example that illustrates git-notes path names
diff mbox series

Message ID pull.692.v2.git.1596471677167.gitgitgadget@gmail.com
State New
Headers show
Series
  • [v2] docs: improve the example that illustrates git-notes path names
Related show

Commit Message

Johannes Schindelin via GitGitGadget Aug. 3, 2020, 4:21 p.m. UTC
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(-)


base-commit: 85b4e0a6dc8407de6f69808d9ee6debdf167ced3

Comments

Taylor Blau Aug. 3, 2020, 4:31 p.m. UTC | #1
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

Patch
diff mbox series

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