Doc notes: Include the format-patch --notes option
authorPhilip Oakley <philipoakley@iee.org>
Sun, 21 Oct 2012 21:34:09 +0000 (22:34 +0100)
committerJeff King <peff@peff.net>
Thu, 25 Oct 2012 10:15:56 +0000 (06:15 -0400)
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>
Documentation/git-notes.txt

index b95aafae2d7540d86d1b804871ef26dfbc41664e..46ef0466beed0b297f986a652e4da1efedf2681c 100644 (file)
@@ -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].