summaryrefslogtreecommitdiff
path: root/Documentation/git-notes.txt
blob: 0d1ada6a0ced4ad0d1df8e32b34eedc7d463547d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
git-notes(1)
============
 
NAME
----
git-notes - Add/inspect commit notes
 
SYNOPSIS
--------
[verse]
'git notes' (edit [-F <file> | -m <msg>] | 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).
 
 
OPTIONS
-------
-m <msg>::
	Use the given note message (instead of prompting).
	If multiple `-m` options are given, their values
	are concatenated as separate paragraphs.
 
-F <file>::
	Take the note message from the given file.  Use '-' to
	read the note message from the standard input.
 
 
Author
------
Written by Johannes Schindelin <johannes.schindelin@gmx.de>
 
Documentation
-------------
Documentation by Johannes Schindelin
 
GIT
---
Part of the linkgit:git[7] suite