Skip to content

Commit b7824ec

Browse files
committed
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. Signed-off-by: Noam Yorav-Raphael <[email protected]>
1 parent 85b4e0a commit b7824ec

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

Documentation/git-notes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ are taken from notes refs. A notes ref is usually a branch which
223223
contains "files" whose paths are the object names for the objects
224224
they describe, with some directory separators included for performance
225225
reasons footnote:[Permitted pathnames have the form
226-
'ab'`/`'cd'`/`'ef'`/`'...'`/`'abcdef...': a sequence of directory
226+
'12'`/`'34'`/`'56'`/`'...'`/`'789abc...': a sequence of directory
227227
names of two hexadecimal digits each followed by a filename with the
228228
rest of the object ID.].
229229

0 commit comments

Comments
 (0)