mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: show usage of branch description

Browse Source 
The branch description will be included in 'git format-patch
--cover-letter' and in 'git pull-request' emails. It can also
be used in the automatic merge message. Tell the reader.

While here, clarify that the description may be a multi-line
explanation of the purpose of the branch's patch series.

Signed-off-by: Philip Oakley <philipoakley@iee.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Philip Oakley
2015-09-14 15:10:53 +01:00
committed by Junio C Hamano
parent ecad27cf98
commit 561d2b7934
4 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation/git-format-patch.txt
View File

@ -213,7 +213,7 @@ feeding the result to `git send-email`.
--[no-]cover-letter::
In addition to the patches, generate a cover letter file
containing the shortlog and the overall diffstat. You can
containing the branch description, shortlog and the overall diffstat. You can
fill in a description in the file before sending it out.
--notes[=<ref>]::