diff options
| author | Junio C Hamano <gitster@pobox.com> | 2009-02-05 19:40:39 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2009-02-05 19:40:39 -0800 |
| commit | 7b75b331f6744fbf953fe8913703378ef86a2189 (patch) | |
| tree | 25154056da08462508e529a7ba92073775d295fd /Documentation/git-notes.txt | |
| parent | 5d680a67d7909c89af96eba4a2d77abed606292b (diff) | |
| parent | 22a3d060937072b0f197a8084af879c753c68fe7 (diff) | |
| download | git-7b75b331f6744fbf953fe8913703378ef86a2189.tar.gz | |
Merge branch 'js/notes'
* js/notes:
git-notes: fix printing of multi-line notes
notes: fix core.notesRef documentation
Add an expensive test for git-notes
Speed up git notes lookup
Add a script to edit/inspect notes
Introduce commit notes
Conflicts:
pretty.c
Diffstat (limited to 'Documentation/git-notes.txt')
| -rw-r--r-- | Documentation/git-notes.txt | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt new file mode 100644 index 0000000000..3d93625f9a --- /dev/null +++ b/Documentation/git-notes.txt @@ -0,0 +1,46 @@ +git-notes(1) +============ + +NAME +---- +git-notes - Add/inspect commit notes + +SYNOPSIS +-------- +[verse] +'git-notes' (edit | show) [commit] + +DESCRIPTION +----------- +This command allows you to add notes to commit messages, without +changing the commit. To discern these notes from the message stored +in the commit object, the notes are indented like the message, after +an unindented line saying "Notes:". + +To disable commit notes, you have to set the config variable +core.notesRef to the empty string. Alternatively, you can set it +to a different ref, something like "refs/notes/bugzilla". This setting +can be overridden by the environment variable "GIT_NOTES_REF". + + +SUBCOMMANDS +----------- + +edit:: + Edit the notes for a given commit (defaults to HEAD). + +show:: + Show the notes for a given commit (defaults to HEAD). + + +Author +------ +Written by Johannes Schindelin <johannes.schindelin@gmx.de> + +Documentation +------------- +Documentation by Johannes Schindelin + +GIT +--- +Part of the gitlink:git[7] suite |