diff options
| author |  Thomas Rast <trast@student.ethz.ch> | 2010-03-12 18:04:37 +0100 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2010-03-12 21:55:40 -0800 |
| commit | 66d681998411e8e5034080d5267a5e0f6cdc0c17 (patch) | |
| tree | 80cac42b9afb968d209e0bd28005941796b0e72d | |
| parent | notes: track whether notes_trees were changed at all (diff) | |
| download | tgif-66d681998411e8e5034080d5267a5e0f6cdc0c17.tar.xz | |
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>
| -rw-r--r-- | Documentation/git-notes.txt | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt index dbfa1e88e6..e2701cff1a 100644 --- a/Documentation/git-notes.txt +++ b/Documentation/git-notes.txt @@ -121,6 +121,20 @@ OPTIONS GIT_NOTES_REF and the "core.notesRef" configuration. The ref is taken to be in `refs/notes/` if it is not qualified. + +NOTES +----- + +Every notes change creates a new commit at the specified notes ref. +You can therefore inspect the history of the notes by invoking, e.g., +`git log -p notes/commits`. + +Currently the commit message only records which operation triggered +the update, and the commit authorship is determined according to the +usual rules (see linkgit:git-commit[1]). These details may change in +the future. + + Author ------ Written by Johannes Schindelin <johannes.schindelin@gmx.de> and |