Code

Documentation: git gc packs refs by default now
[git.git] / Documentation / git-notes.txt
1 git-notes(1)
2 ============
4 NAME
5 ----
6 git-notes - Add/inspect commit notes
8 SYNOPSIS
9 --------
10 [verse]
11 'git-notes' (edit [-F <file> | -m <msg>] | show) [commit]
13 DESCRIPTION
14 -----------
15 This command allows you to add notes to commit messages, without
16 changing the commit.  To discern these notes from the message stored
17 in the commit object, the notes are indented like the message, after
18 an unindented line saying "Notes:".
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".
26 SUBCOMMANDS
27 -----------
29 edit::
30         Edit the notes for a given commit (defaults to HEAD).
32 show::
33         Show the notes for a given commit (defaults to HEAD).
36 OPTIONS
37 -------
38 -m <msg>::
39         Use the given note message (instead of prompting).
40         If multiple `-m` (or `-F`) options are given, their
41         values are concatenated as separate paragraphs.
43 -F <file>::
44         Take the note message from the given file.  Use '-' to
45         read the note message from the standard input.
46         If multiple `-F` (or `-m`) options are given, their
47         values are concatenated as separate paragraphs.
50 Author
51 ------
52 Written by Johannes Schindelin <johannes.schindelin@gmx.de>
54 Documentation
55 -------------
56 Documentation by Johannes Schindelin
58 GIT
59 ---
60 Part of the linkgit:git[7] suite