doc: show usage of branch description
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:

committed by
Junio C Hamano

parent
ecad27cf98
commit
561d2b7934
@ -14,7 +14,8 @@ DESCRIPTION
|
||||
-----------
|
||||
|
||||
Generate a request asking your upstream project to pull changes into
|
||||
their tree. The request, printed to the standard output, summarizes
|
||||
their tree. The request, printed to the standard output,
|
||||
begins with the branch description, summarizes
|
||||
the changes and indicates from where they can be pulled.
|
||||
|
||||
The upstream project is expected to have the commit named by
|
||||
|
Reference in New Issue
Block a user