From f43c97f5720f48598e59629f7dc9892d082d8b0e Mon Sep 17 00:00:00 2001 From: Nanako Shiraishi Date: Tue, 25 Aug 2009 17:20:00 +0900 Subject: 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 Signed-off-by: Junio C Hamano --- Documentation/git-am.txt | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) (limited to 'Documentation/git-am.txt') diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt index fcacc9465..e6ab3dfa5 100644 --- a/Documentation/git-am.txt +++ b/Documentation/git-am.txt @@ -128,10 +128,18 @@ the commit, after stripping common prefix "[PATCH ]". The "Subject: " line is supposed to concisely describe what the commit is about in one line of text. -"From: " and "Subject: " lines starting the body (the rest of the -message after the blank line terminating the RFC2822 headers) -override the respective commit author name and title values taken -from the headers. +A line that mainly consists of scissors (either ">8" or "8<") and +perforation (dash "-") marks is called a scissors line, and is used to +request the reader to cut the message at that line. If such a line +appears in the body of the message before the patch, everything before it +(including the scissors line itself) is ignored. This is useful if you +want to begin your message in a discussion thread with comments and +suggestions on the message you are responding to, and to conclude it with +a patch submission, separating the discussion and the beginning of the +proposed commit log message with a scissors line. + +"From: " and "Subject: " lines starting the body override the respective +commit author name and title values taken from the headers. The commit message is formed by the title taken from the "Subject: ", a blank line and the body of the message up to -- cgit v1.2.1