[PATCH v6 13/13] git-notes(1): add a section about the meaning of history
- From
Thomas Rast <trast@student.ethz.ch>
- Date
- Mar 10, 2010, 14:06 UTC
- Message-ID
- <2a789ed6300651d06fbe5835184e2669a2c483cc.1268229087.git.trast@student.ethz.ch>
- In-Reply-To
- <cover.1268229087.git.trast@student.ethz.ch>
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> ---
New in v6, as per Junio's comment
Show 5 quoted lines
> - As to the determination of committer/author identity, I think what the > code currently does (i.e. honor the environment and user.* config) is > perfectly sane, but at the same time I think it would be surprising for > unsuspecting users. We may want to advise users about this in the > documentation.
(but see the series leader for more discussion about this).
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 02a2baf..4e5113b 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
-- 1.7.0.2.407.g21ebda