[PATCH 5/6] Document git-notes
From: Johannes Schindelin <hidden>
Date: 2016-06-15 22:43:21
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Signed-off-by: Johannes Schindelin <redacted> --- Documentation/cmd-list.perl | 1 + Documentation/git-notes.txt | 45 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+), 0 deletions(-) create mode 100644 Documentation/git-notes.txt
diff --git a/Documentation/cmd-list.perl b/Documentation/cmd-list.perl
index 2143995..f05e291 100755
--- a/Documentation/cmd-list.perl
+++ b/Documentation/cmd-list.perl@@ -140,6 +140,7 @@ git-mergetool ancillarymanipulators git-mktag plumbingmanipulators git-mktree plumbingmanipulators git-mv mainporcelain +git-notes mainporcelain git-name-rev plumbinginterrogators git-pack-objects plumbingmanipulators git-pack-redundant plumbinginterrogators
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
new file mode 100644
index 0000000..331ed89
--- /dev/null
+++ b/Documentation/git-notes.txt@@ -0,0 +1,45 @@ +git-notes(1) +============ + +NAME +---- +git-notes - Add commit notes + +SYNOPSIS +-------- +[verse] +'git-notes' (edit | show) [commit + +DESCRIPTION +----------- +This command allows you to add notes to commit messages, after the +fact. 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 enable commit notes, you have to set the config variable +core.notesRef to something like "refs/notes/commits". 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). + + +Author +------ +Written by Johannes Schindelin <johannes.schindelin@gmx.de> + +Documentation +------------- +Documentation by Johannes Schindelin + +GIT +--- +Part of the gitlink:git[7] suite
--
1.5.3.rc1.2718.gd2dc9-dirty