projects / thirdparty / git.git / blame
| Commit | Line | Data |
|---|---|---|
| 65d9fb48 JS |
1 | git-notes(1) |
| 2 | ============ | |
| 3 | ||
| 4 | NAME | |
| 5 | ---- | |
| 6 | git-notes - Add/inspect commit notes | |
| 7 | ||
| 8 | SYNOPSIS | |
| 9 | -------- | |
| 10 | [verse] | |
| d6576e1f | 11 | 'git notes' (edit [-F <file> | -m <msg>] | show | remove | prune) [commit] |
| 65d9fb48 JS |
12 | |
| 13 | DESCRIPTION | |
| 14 | ----------- | |
| 92b3385f JH |
15 | This command allows you to add/remove notes to/from commit messages, |
| 16 | without changing the commit. To discern these notes from the message | |
| 17 | stored in the commit object, the notes are indented like the message, | |
| 18 | after an unindented line saying "Notes:". | |
| 65d9fb48 JS |
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 | ||
| 92b3385f JH |
35 | remove:: |
| 36 | Remove the notes for a given commit (defaults to HEAD). | |
| 37 | This is equivalent to specifying an empty note message to | |
| 38 | the `edit` subcommand. | |
| 39 | ||
| d6576e1f JH |
40 | prune:: |
| 41 | Remove all notes for non-existing/unreachable objects. | |
| 65d9fb48 | 42 | |
| d9246d43 JH |
43 | OPTIONS |
| 44 | ------- | |
| 45 | -m <msg>:: | |
| 46 | Use the given note message (instead of prompting). | |
| cd067d3b JH |
47 | If multiple `-m` options are given, their values |
| 48 | are concatenated as separate paragraphs. | |
| d9246d43 JH |
49 | |
| 50 | -F <file>:: | |
| 51 | Take the note message from the given file. Use '-' to | |
| 52 | read the note message from the standard input. | |
| d9246d43 JH |
53 | |
| 54 | ||
| 65d9fb48 JS |
55 | Author |
| 56 | ------ | |
| 57 | Written by Johannes Schindelin <johannes.schindelin@gmx.de> | |
| 58 | ||
| 59 | Documentation | |
| 60 | ------------- | |
| 61 | Documentation by Johannes Schindelin | |
| 62 | ||
| 63 | GIT | |
| 64 | --- | |
| 65 | Part of the linkgit:git[7] suite |