[thirdparty/git.git] / Documentation / git-notes.txt

git-notes(1)
============

NAME
----
git-notes - Add/inspect object notes

SYNOPSIS
--------
[verse]
'git notes' [list [<object>]]
'git notes' edit [-F <file> | -m <msg>] [<object>]
'git notes' show [<object>]
'git notes' remove [<object>]
'git notes' prune


DESCRIPTION
-----------
This command allows you to add/remove notes to/from objects, without
changing the objects themselves.

A typical use of notes is to extend a commit message without having
to change the commit itself. Such commit notes can be shown by `git log`
along with the original commit message. 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 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
-----------

list::
	List the notes object for a given object. If no object is
	given, show a list of all note objects and the objects they
	annotate (in the format "<note object> <annotated object>").
	This is the default subcommand if no subcommand is given.

edit::
	Edit the notes for a given object (defaults to HEAD).

show::
	Show the notes for a given object (defaults to HEAD).

remove::
	Remove the notes for a given object (defaults to HEAD).
	This is equivalent to specifying an empty note message to
	the `edit` subcommand.

prune::
	Remove all notes for non-existing/unreachable objects.

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> and
Johan Herland <johan@herland.net>

Documentation
-------------
Documentation by Johannes Schindelin and Johan Herland

GIT
---
Part of the linkgit:git[7] suite
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 JH	11	'git notes' [list [<object>]]
	12	'git notes' edit [-F <file> \| -m <msg>] [<object>]
	13	'git notes' show [<object>]
	14	'git notes' remove [<object>]
	15	'git notes' prune
	16
65d9fb48 JS	17
	18	DESCRIPTION
	19	-----------
7d541174 JH	20	This command allows you to add/remove notes to/from objects, without
7d541174 JH	21	changing the objects themselves.
65d9fb48	22
7d541174 JH	23	A typical use of notes is to extend a commit message without having
	24	to change the commit itself. Such commit notes can be shown by `git log`
	25	along with the original commit message. To discern these notes from the
	26	message stored in the commit object, the notes are indented like the
	27	message, after an unindented line saying "Notes:".
	28
	29	To disable notes, you have to set the config variable core.notesRef to
	30	the empty string. Alternatively, you can set it to a different ref,
	31	something like "refs/notes/bugzilla". This setting can be overridden
	32	by the environment variable "GIT_NOTES_REF".
65d9fb48 JS	33
	34
	35	SUBCOMMANDS
	36	-----------
	37
e397421a JH	38	list::
	39	List the notes object for a given object. If no object is
	40	given, show a list of all note objects and the objects they
	41	annotate (in the format "<note object> <annotated object>").
	42	This is the default subcommand if no subcommand is given.
	43
65d9fb48	44	edit::
7d541174	45	Edit the notes for a given object (defaults to HEAD).
65d9fb48 JS	46
65d9fb48 JS	47	show::
7d541174	48	Show the notes for a given object (defaults to HEAD).
65d9fb48	49
92b3385f	50	remove::
7d541174	51	Remove the notes for a given object (defaults to HEAD).
92b3385f JH	52	This is equivalent to specifying an empty note message to
	53	the `edit` subcommand.
	54
d6576e1f JH	55	prune::
d6576e1f JH	56	Remove all notes for non-existing/unreachable objects.
65d9fb48	57
d9246d43 JH	58	OPTIONS
	59	-------
	60	-m <msg>::
	61	Use the given note message (instead of prompting).
cd067d3b JH	62	If multiple `-m` options are given, their values
cd067d3b JH	63	are concatenated as separate paragraphs.
d9246d43 JH	64
	65	-F <file>::
	66	Take the note message from the given file. Use '-' to
	67	read the note message from the standard input.
d9246d43 JH	68
d9246d43 JH	69
65d9fb48 JS	70	Author
65d9fb48 JS	71	------
7d541174 JH	72	Written by Johannes Schindelin <johannes.schindelin@gmx.de> and
7d541174 JH	73	Johan Herland <johan@herland.net>
65d9fb48 JS	74
	75	Documentation
	76	-------------
7d541174	77	Documentation by Johannes Schindelin and Johan Herland
65d9fb48 JS	78
	79	GIT
	80	---
	81	Part of the linkgit:git[7] suite