Skip to content

Commit 66d6819

Browse files
trastgitster
authored andcommitted
git-notes(1): add a section about the meaning of history
To the displaying code, the only interesting thing about a notes ref is that it has a tree of the required format. However, notes actually have a history since they are recorded as successive commits. Make a note about the existence of this history in the manpage, but keep some doors open if we want to change the details. Signed-off-by: Thomas Rast <[email protected]> Acked-by: Johan Herland <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 7f710ea commit 66d6819

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

Documentation/git-notes.txt

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,20 @@ OPTIONS
121121
GIT_NOTES_REF and the "core.notesRef" configuration. The ref
122122
is taken to be in `refs/notes/` if it is not qualified.
123123

124+
125+
NOTES
126+
-----
127+
128+
Every notes change creates a new commit at the specified notes ref.
129+
You can therefore inspect the history of the notes by invoking, e.g.,
130+
`git log -p notes/commits`.
131+
132+
Currently the commit message only records which operation triggered
133+
the update, and the commit authorship is determined according to the
134+
usual rules (see linkgit:git-commit[1]). These details may change in
135+
the future.
136+
137+
124138
Author
125139
------
126140
Written by Johannes Schindelin <[email protected]> and

0 commit comments

Comments
 (0)