Skip to content

Commit f43c97f

Browse files
Nanako Shiraishigitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 200c75f commit f43c97f

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

Documentation/git-am.txt

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,10 +128,18 @@ the commit, after stripping common prefix "[PATCH <anything>]".
128128
The "Subject: " line is supposed to concisely describe what the
129129
commit is about in one line of text.
130130

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.
135143

136144
The commit message is formed by the title taken from the
137145
"Subject: ", a blank line and the body of the message up to

0 commit comments

Comments
 (0)