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

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

NAME
----
git-notes - Add/inspect commit notes

SYNOPSIS
--------
[verse]
'git notes' (edit [-F <file> | -m <msg>] | show | remove) [commit]

DESCRIPTION
-----------
This command allows you to add/remove notes to/from 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).

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


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
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]
92b3385f	11	'git notes' (edit [-F <file> \| -m <msg>] \| show \| remove) [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
65d9fb48	40
d9246d43 JH	41	OPTIONS
	42	-------
	43	-m <msg>::
	44	Use the given note message (instead of prompting).
cd067d3b JH	45	If multiple `-m` options are given, their values
cd067d3b JH	46	are concatenated as separate paragraphs.
d9246d43 JH	47
	48	-F <file>::
	49	Take the note message from the given file. Use '-' to
	50	read the note message from the standard input.
d9246d43 JH	51
d9246d43 JH	52
65d9fb48 JS	53	Author
	54	------
	55	Written by Johannes Schindelin <johannes.schindelin@gmx.de>
	56
	57	Documentation
	58	-------------
	59	Documentation by Johannes Schindelin
	60
	61	GIT
	62	---
	63	Part of the linkgit:git[7] suite