mirror of
https://github.com/git/git.git
synced 2024-09-28 08:49:45 +02:00
7aa4754e55
"git notes add" is identical to "git notes edit" except that instead of editing existing notes for a given object, you can only add notes to an object that currently has none. If "git notes add" finds existing notes for the given object, the addition is aborted. However, if the new -f/--force option is used, "git notes add" will _overwrite_ the existing notes with the new notes contents. If there is no existing notes for the given object. "git notes add" is identical to "git notes edit" (i.e. it adds a new note). The patch includes tests verifying correct behaviour of the new subcommand. Suggested-by: Joey Hess <joey@kitenet.net> Improved-by: Junio C Hamano <gitster@pobox.com> Signed-off-by: Johan Herland <johan@herland.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
95 lines
2.4 KiB
Plaintext
95 lines
2.4 KiB
Plaintext
git-notes(1)
|
|
============
|
|
|
|
NAME
|
|
----
|
|
git-notes - Add/inspect object notes
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'git notes' [list [<object>]]
|
|
'git notes' add [-f] [-F <file> | -m <msg>] [<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.
|
|
|
|
add::
|
|
Add notes for a given object (defaults to HEAD). Abort if the
|
|
object already has notes, abort. (use `-f` to overwrite an
|
|
existing note).
|
|
|
|
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
|
|
-------
|
|
-f::
|
|
--force::
|
|
When adding notes to an object that already has notes,
|
|
overwrite the existing notes (instead of aborting).
|
|
|
|
-m <msg>::
|
|
--message=<msg>::
|
|
Use the given note message (instead of prompting).
|
|
If multiple `-m` options are given, their values
|
|
are concatenated as separate paragraphs.
|
|
|
|
-F <file>::
|
|
--file=<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
|