From: Philip Oakley <philipoakley@iee.org>
Date: Sun, 21 Oct 2012 21:34:09 +0000 (+0100)
Subject: Doc notes: Include the format-patch --notes option
X-Git-Tag: v1.8.1-rc0~58^2~3
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/e39b307d09c41ff660f4ddfcecbcb08177fcd4f3?ds=inline;hp=-c

Doc notes: Include the format-patch --notes option

git format-patch gained a --notes option. Tell the notes user.

Signed-off-by: Philip Oakley <philipoakley@iee.org>
Signed-off-by: Jeff King <peff@peff.net>
---

e39b307d09c41ff660f4ddfcecbcb08177fcd4f3
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index b95aafae2d..46ef0466be 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -39,6 +39,10 @@ message stored in the commit object, the notes are indented like the
 message, after an unindented line saying "Notes (<refname>):" (or
 "Notes:" for `refs/notes/commits`).
 
+Notes can also be added to patches prepared with `git format-patch` by
+using the `--notes` option. Such notes are added as a patch commentary
+after a three dash separator line.
+
 To change which notes are shown by 'git log', see the
 "notes.displayRef" configuration in linkgit:git-log[1].