git@vger.kernel.org list mirror (unofficial, one of many)
 help / color / mirror / code / Atom feed
From: "Noam Yorav-Raphael via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Noam Yorav-Raphael <noamraph@gmail.com>,
	Noam Yorav-Raphael <noamraph@gmail.com>
Subject: [PATCH v2] docs: improve the example that illustrates git-notes path names
Date: Mon, 03 Aug 2020 16:21:16 +0000	[thread overview]
Message-ID: <pull.692.v2.git.1596471677167.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.692.git.1596465817121.gitgitgadget@gmail.com>

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

  parent reply	other threads:[~2020-08-03 16:21 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-03 14:43 [PATCH] " 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 ` Noam Yorav-Raphael via GitGitGadget [this message]
2020-08-03 16:31   ` [PATCH v2] " 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:
  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=pull.692.v2.git.1596471677167.gitgitgadget@gmail.com \
    --to=gitgitgadget@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=noamraph@gmail.com \
    --subject='Re: [PATCH v2] docs: improve the example that illustrates git-notes path names' \
    /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

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