Documentation/git-notes.txt

   1 git-notes(1)
   2 ============
   3
   4 NAME
   5 ----
   6 git-notes - Add/inspect object notes
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  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
  17
  18 DESCRIPTION
  19 -----------
  20 This command allows you to add/remove notes to/from objects, without
  21 changing the objects themselves.
  22
  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".
  33
  34
  35 SUBCOMMANDS
  36 -----------
  37
  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
  44 edit::
  45         Edit the notes for a given object (defaults to HEAD).
  46
  47 show::
  48         Show the notes for a given object (defaults to HEAD).
  49
  50 remove::
  51         Remove the notes for a given object (defaults to HEAD).
  52         This is equivalent to specifying an empty note message to
  53         the `edit` subcommand.
  54
  55 prune::
  56         Remove all notes for non-existing/unreachable objects.
  57
  58 OPTIONS
  59 -------
  60 -m <msg>::
  61 --message=<msg>::
  62         Use the given note message (instead of prompting).
  63         If multiple `-m` options are given, their values
  64         are concatenated as separate paragraphs.
  65
  66 -F <file>::
  67 --file=<file>::
  68         Take the note message from the given file.  Use '-' to
  69         read the note message from the standard input.
  70
  71
  72 Author
  73 ------
  74 Written by Johannes Schindelin <johannes.schindelin@gmx.de> and
  75 Johan Herland <johan@herland.net>
  76
  77 Documentation
  78 -------------
  79 Documentation by Johannes Schindelin and Johan Herland
  80
  81 GIT
  82 ---
  83 Part of the linkgit:git[7] suite