From: Jonathan Nieder <jrnieder@gmail.com>
To: git@vger.kernel.org
Cc: Thomas Rast <trast@student.ethz.ch>,
Johan Herland <johan@herland.net>,
Johannes Schindelin <Johannes.Schindelin@gmx.de>
Subject: [PATCH 3/4] Documentation/notes: describe content of notes
Date: Mon, 3 May 2010 18:42:29 -0500 [thread overview]
Message-ID: <20100503234229.GC27483@progeny.tock> (raw)
In-Reply-To: <20100503233604.GA27451@progeny.tock>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
Documentation/git-notes.txt | 4 ++++
1 files changed, 4 insertions(+), 0 deletions(-)
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index 0594776..273264b 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -27,6 +27,10 @@ By default, notes are saved to and read from `refs/notes/commits`, but
this default can be overridden. See the CONFIGURATION and ENVIRONMENT
sections below.
+Notes can contain any sequence of non-null bytes. Since they are
+sanitized with linkgit:git-stripspace[1], empty lines other than a
+single line separating paragraphs are not significant.
+
A typical use of notes is to extend a commit message without having
to change the commit itself. Such commit notes can be shown by `git log`
along with the original commit message. To discern these notes from the
--
1.7.1
next prev parent reply other threads:[~2010-05-03 23:42 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-05-03 23:36 [PATCH 0/4] Documentation/notes: fill out the man page a little Jonathan Nieder
2010-05-03 23:41 ` [PATCH 1/4] Documentation/notes: describe effect of environment and configuration Jonathan Nieder
2010-05-04 9:24 ` Thomas Rast
2010-05-03 23:42 ` [PATCH 2/4] Documentation/notes: adjust description to use configuration section Jonathan Nieder
2010-05-03 23:42 ` Jonathan Nieder [this message]
2010-05-04 9:28 ` [PATCH 3/4] Documentation/notes: describe content of notes Thomas Rast
2010-05-04 9:55 ` Johan Herland
2010-05-05 3:23 ` Jeff King
2010-05-03 23:47 ` [PATCH 4/4] Documentation/notes: nitpicks Jonathan Nieder
2010-05-04 7:09 ` Thomas Rast
2010-05-04 7:23 ` Jonathan Nieder
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20100503234229.GC27483@progeny.tock \
--to=jrnieder@gmail.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=johan@herland.net \
--cc=trast@student.ethz.ch \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).