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 <trast@student.ethz.ch> Acked-by: Johan Herland <johan@herland.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Thomas Rast committed
Mar 12, 2010 at 18:04 UTC
66d681998411e8e5034080d5267a5e0f6cdc0c17
1 file changed
+14
Documentation/git-notes.txt
+14
@@ -121,6 +121,20 @@ OPTIONS
121
GIT_NOTES_REF and the "core.notesRef" configuration. The ref
122
is taken to be in `refs/notes/` if it is not qualified.
123
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
+
138
Author
139
------
140
Written by Johannes Schindelin <johannes.schindelin@gmx.de> and