]>
Commit | Line | Data |
---|---|---|
65d9fb48 JS |
1 | git-notes(1) |
2 | ============ | |
3 | ||
4 | NAME | |
5 | ---- | |
7d541174 | 6 | git-notes - Add/inspect object notes |
65d9fb48 JS |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
10 | [verse] | |
e397421a | 11 | 'git notes' [list [<object>]] |
0691cff7 | 12 | 'git notes' add [-f] [-F <file> | -m <msg> | (-c | -C) <object>] [<object>] |
160baa0d | 13 | 'git notes' copy [-f] ( --stdin | <from-object> <to-object> ) |
0691cff7 | 14 | 'git notes' append [-F <file> | -m <msg> | (-c | -C) <object>] [<object>] |
aaec9bcf | 15 | 'git notes' edit [<object>] |
e397421a JH |
16 | 'git notes' show [<object>] |
17 | 'git notes' remove [<object>] | |
18 | 'git notes' prune | |
19 | ||
65d9fb48 JS |
20 | |
21 | DESCRIPTION | |
22 | ----------- | |
7d541174 JH |
23 | This command allows you to add/remove notes to/from objects, without |
24 | changing the objects themselves. | |
65d9fb48 | 25 | |
7d541174 JH |
26 | A typical use of notes is to extend a commit message without having |
27 | to change the commit itself. Such commit notes can be shown by `git log` | |
28 | along with the original commit message. To discern these notes from the | |
29 | message stored in the commit object, the notes are indented like the | |
894a9d33 TR |
30 | message, after an unindented line saying "Notes (<refname>):" (or |
31 | "Notes:" for the default setting). | |
7d541174 | 32 | |
894a9d33 TR |
33 | This command always manipulates the notes specified in "core.notesRef" |
34 | (see linkgit:git-config[1]), which can be overridden by GIT_NOTES_REF. | |
35 | To change which notes are shown by 'git-log', see the | |
36 | "notes.displayRef" configuration. | |
65d9fb48 | 37 | |
6956f858 TR |
38 | See the description of "notes.rewrite.<command>" in |
39 | linkgit:git-config[1] for a way of carrying your notes across commands | |
40 | that rewrite commits. | |
41 | ||
65d9fb48 JS |
42 | |
43 | SUBCOMMANDS | |
44 | ----------- | |
45 | ||
e397421a JH |
46 | list:: |
47 | List the notes object for a given object. If no object is | |
48 | given, show a list of all note objects and the objects they | |
49 | annotate (in the format "<note object> <annotated object>"). | |
50 | This is the default subcommand if no subcommand is given. | |
51 | ||
7aa4754e JH |
52 | add:: |
53 | Add notes for a given object (defaults to HEAD). Abort if the | |
54 | object already has notes, abort. (use `-f` to overwrite an | |
55 | existing note). | |
56 | ||
e73bbd96 JH |
57 | copy:: |
58 | Copy the notes for the first object onto the second object. | |
59 | Abort if the second object already has notes, or if the first | |
60 | objects has none. (use -f to overwrite existing notes to the | |
61 | second object). This subcommand is equivalent to: | |
62 | `git notes add [-f] -C $(git notes list <from-object>) <to-object>` | |
160baa0d TR |
63 | + |
64 | In `\--stdin` mode, take lines in the format | |
65 | + | |
66 | ---------- | |
67 | <from-object> SP <to-object> [ SP <rest> ] LF | |
68 | ---------- | |
69 | + | |
70 | on standard input, and copy the notes from each <from-object> to its | |
71 | corresponding <to-object>. (The optional `<rest>` is ignored so that | |
72 | the command can read the input given to the `post-rewrite` hook.) | |
e73bbd96 | 73 | |
2347fae5 JH |
74 | append:: |
75 | Append to the notes of an existing object (defaults to HEAD). | |
76 | Creates a new notes object if needed. | |
77 | ||
65d9fb48 | 78 | edit:: |
7d541174 | 79 | Edit the notes for a given object (defaults to HEAD). |
65d9fb48 JS |
80 | |
81 | show:: | |
7d541174 | 82 | Show the notes for a given object (defaults to HEAD). |
65d9fb48 | 83 | |
92b3385f | 84 | remove:: |
7d541174 | 85 | Remove the notes for a given object (defaults to HEAD). |
92b3385f JH |
86 | This is equivalent to specifying an empty note message to |
87 | the `edit` subcommand. | |
88 | ||
d6576e1f JH |
89 | prune:: |
90 | Remove all notes for non-existing/unreachable objects. | |
65d9fb48 | 91 | |
d9246d43 JH |
92 | OPTIONS |
93 | ------- | |
7aa4754e JH |
94 | -f:: |
95 | --force:: | |
96 | When adding notes to an object that already has notes, | |
97 | overwrite the existing notes (instead of aborting). | |
98 | ||
d9246d43 | 99 | -m <msg>:: |
ba20f15e | 100 | --message=<msg>:: |
d9246d43 | 101 | Use the given note message (instead of prompting). |
cd067d3b JH |
102 | If multiple `-m` options are given, their values |
103 | are concatenated as separate paragraphs. | |
d9246d43 JH |
104 | |
105 | -F <file>:: | |
ba20f15e | 106 | --file=<file>:: |
d9246d43 JH |
107 | Take the note message from the given file. Use '-' to |
108 | read the note message from the standard input. | |
d9246d43 | 109 | |
0691cff7 JH |
110 | -C <object>:: |
111 | --reuse-message=<object>:: | |
112 | Reuse the note message from the given note object. | |
113 | ||
114 | -c <object>:: | |
115 | --reedit-message=<object>:: | |
116 | Like '-C', but with '-c' the editor is invoked, so that | |
117 | the user can further edit the note message. | |
d9246d43 | 118 | |
dcf783a2 TR |
119 | --ref <ref>:: |
120 | Manipulate the notes tree in <ref>. This overrides both | |
121 | GIT_NOTES_REF and the "core.notesRef" configuration. The ref | |
122 | is taken to be in `refs/notes/` if it is not qualified. | |
123 | ||
65d9fb48 JS |
124 | Author |
125 | ------ | |
7d541174 JH |
126 | Written by Johannes Schindelin <johannes.schindelin@gmx.de> and |
127 | Johan Herland <johan@herland.net> | |
65d9fb48 JS |
128 | |
129 | Documentation | |
130 | ------------- | |
7d541174 | 131 | Documentation by Johannes Schindelin and Johan Herland |
65d9fb48 JS |
132 | |
133 | GIT | |
134 | --- | |
135 | Part of the linkgit:git[7] suite |