login
Header Space

 
 

[PATCH 5/6] Document git-notes

Previous message: [thread] [date] [author]
Next message: [thread] [date] [author]
To: Alberto Bertogli <albertito@...>, <git@...>, <gitster@...>, Johan Herland <johan@...>
Date: Sunday, July 15, 2007 - 7:24 pm

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
---
 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


-
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Previous message: [thread] [date] [author]
Next message: [thread] [date] [author]

Messages in current thread:
[PATCH 0/6] Introduce commit notes, Johannes Schindelin, (Sun Jul 15, 7:19 pm)
Re: [PATCH 0/6] Introduce commit notes, Andy Parkins, (Mon Jul 16, 3:57 am)
Re: [PATCH 0/6] Introduce commit notes, Junio C Hamano, (Mon Jul 16, 4:11 am)
Re: [PATCH 0/6] Introduce commit notes, Johannes Schindelin, (Mon Jul 16, 12:26 pm)
Re: [PATCH 0/6] Introduce commit notes, Junio C Hamano, (Mon Jul 16, 1:56 pm)
Re: [PATCH 0/6] Introduce commit notes, Johannes Schindelin, (Wed Jul 18, 9:34 pm)
[WIP PATCH 6/6] notes: add notes-index for a substantial spe..., Johannes Schindelin, (Sun Jul 15, 7:26 pm)
Re: [WIP PATCH 6/6] notes: add notes-index for a substantial..., Johannes Schindelin, (Mon Jul 16, 12:29 pm)
Re: [WIP PATCH 6/6] notes: add notes-index for a substantial..., Johannes Schindelin, (Sun Jul 15, 7:33 pm)
[PATCH 5/6] Document git-notes, Johannes Schindelin, (Sun Jul 15, 7:24 pm)
[PATCH 4/6] Add a test script for "git notes", Johannes Schindelin, (Sun Jul 15, 7:24 pm)
[PATCH 3/6] Add git-notes, Johannes Schindelin, (Sun Jul 15, 7:23 pm)
[PATCH 2/6] Introduce commit notes, Johannes Schindelin, (Sun Jul 15, 7:23 pm)
Re: [PATCH 2/6] Introduce commit notes, Junio C Hamano, (Sun Jul 15, 7:36 pm)
Re: [PATCH 2/6] Introduce commit notes, Junio C Hamano, (Sun Jul 15, 8:05 pm)
Re: [PATCH 2/6] Introduce commit notes, Johannes Schindelin, (Sun Jul 15, 7:52 pm)
[PATCH 1/6] Rename git_one_line() to git_line_length() and e..., Johannes Schindelin, (Sun Jul 15, 7:22 pm)
speck-geostationary