[PATCH] docs/git-mailinfo: Mention the manual separator (---)
And explain how it interacts with the scissors setting.
Signed-off-by: W. Trevor King <wking@tremily.us>
---
The three-dash limit comes from f0658cf2 (restrict the patch
filtering, 2007-03-12), but I couldn't find any associated
documentation. Since the effect is so similar to the scissors line, I
thought about adding the information to the --scissors entry. The
manual separator is really independent from the scissors though, so I
settled on explaining both separators in the DESCRIPTION.
This patch is against 'maint'.
Documentation/git-mailinfo.txt | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt
index 164a3c6..6c6c527 100644
--- a/Documentation/git-mailinfo.txt
+++ b/Documentation/git-mailinfo.txt
@@ -21,6 +21,29 @@ written out to the standard output to be used by 'git am'
to create a commit. It is usually not necessary to use this
command directly. See linkgit:git-am[1] instead.
+The commit message extracted from the e-mail depends on the scissors
+setting (see '--[no-]scissors' in the OPTIONS section). Besides the
+scissors option (which discards content before the scissors), you can
+also use '---' as a separator (which discards content after the
+separator). For example, without scissors you can have a body like
+this:
+
+------------
+Your commit message.
+---
+Comments that aren't part of the commit message.
+------------
+
+With scissors, you can have a body like this:
+
+------------
+Comments that aren't part of the commit message.
+--->8---
+Your commit message.
+---
+More comments that aren't part of the commit message.
+------------
+
OPTIONS
-------
--
2.1.0.60.g85f0837
W. Trevor King <wking@tremily.us>