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