summaryrefslogtreecommitdiff
path: root/Documentation/git-format-patch.txt
diff options
context:
space:
mode:
authorPhilip Oakley <philipoakley@iee.org>2015-09-14 14:10:53 (GMT)
committerJunio C Hamano <gitster@pobox.com>2015-09-14 19:50:33 (GMT)
commit561d2b7934caaa5e0917979da82ca59b17a4e5f9 (patch)
tree73f45ac56de72ced86792d271b82c6d218d32f54 /Documentation/git-format-patch.txt
parentecad27cf98c391d5cfdc26ce0e442e02347baad0 (diff)
downloadgit-561d2b7934caaa5e0917979da82ca59b17a4e5f9.zip
git-561d2b7934caaa5e0917979da82ca59b17a4e5f9.tar.gz
git-561d2b7934caaa5e0917979da82ca59b17a4e5f9.tar.bz2
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>
Diffstat (limited to 'Documentation/git-format-patch.txt')
-rw-r--r--Documentation/git-format-patch.txt2
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index c0fd470..037ceb2 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -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>]::