From: Noam Yorav-Raphael <noamraph@xxxxxxxxx>
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@xxxxxxxxx>
---
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
