projects / thirdparty / git.git / blame
| Commit | Line | Data |
|---|---|---|
| 055a5975 JS |
1 | git-notes(1) |
| 2 | ============ | |
| 3 | ||
| 4 | NAME | |
| 5 | ---- | |
| 6 | git-notes - Add/inspect commit notes | |
| 7 | ||
| 8 | SYNOPSIS | |
| 9 | -------- | |
| 10 | [verse] | |
| 11 | 'git-notes' (edit | show) [commit] | |
| 12 | ||
| 13 | DESCRIPTION | |
| 14 | ----------- | |
| 15 | This command allows you to add notes to commit messages, without | |
| 16 | changing the commit. To discern these notes from the message stored | |
| 17 | in the commit object, the notes are indented like the message, after | |
| 18 | an unindented line saying "Notes:". | |
| 19 | ||
| 20 | To disable commit notes, you have to set the config variable | |
| 21 | core.notesRef to the empty string. Alternatively, you can set it | |
| 22 | to a different ref, something like "refs/notes/bugzilla". This setting | |
| 23 | can be overridden by the environment variable "GIT_NOTES_REF". | |
| 24 | ||
| 25 | ||
| 26 | SUBCOMMANDS | |
| 27 | ----------- | |
| 28 | ||
| 29 | edit:: | |
| 30 | Edit the notes for a given commit (defaults to HEAD). | |
| 31 | ||
| 32 | show:: | |
| 33 | Show the notes for a given commit (defaults to HEAD). | |
| 34 | ||
| 35 | ||
| 36 | Author | |
| 37 | ------ | |
| 38 | Written by Johannes Schindelin <johannes.schindelin@gmx.de> | |
| 39 | ||
| 40 | Documentation | |
| 41 | ------------- | |
| 42 | Documentation by Johannes Schindelin | |
| 43 | ||
| 44 | GIT | |
| 45 | --- | |
| 46 | Part of the gitlink:git[7] suite |