Documentation: describe the scissors mark support of "git am"
Describe what a scissors mark looks like, and explain in what situation it is often used. Signed-off-by: Nanako Shiraishi <nanako3@lavabit.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Nanako Shiraishi committed
Aug 25, 2009 at 17:20 UTC
f43c97f5720f48598e59629f7dc9892d082d8b0e
1 file changed
+12
-4
Documentation/git-am.txt
+12
-4
@@ -128,10 +128,18 @@ the commit, after stripping common prefix "[PATCH <anything>]".
128
The "Subject: " line is supposed to concisely describe what the
129
commit is about in one line of text.
130
131
-"From: " and "Subject: " lines starting the body (the rest of the
132
-message after the blank line terminating the RFC2822 headers)
133
-override the respective commit author name and title values taken
134
-from the headers.
131
+A line that mainly consists of scissors (either ">8" or "8<") and
132
+perforation (dash "-") marks is called a scissors line, and is used to
133
+request the reader to cut the message at that line. If such a line
134
+appears in the body of the message before the patch, everything before it
135
+(including the scissors line itself) is ignored. This is useful if you
136
+want to begin your message in a discussion thread with comments and
137
+suggestions on the message you are responding to, and to conclude it with
138
+a patch submission, separating the discussion and the beginning of the
139
+proposed commit log message with a scissors line.
140
+
141
+"From: " and "Subject: " lines starting the body override the respective
142
+commit author name and title values taken from the headers.
143
144
The commit message is formed by the title taken from the
145
"Subject: ", a blank line and the body of the message up to