From 561d2b7934caaa5e0917979da82ca59b17a4e5f9 Mon Sep 17 00:00:00 2001 From: Philip Oakley Date: Mon, 14 Sep 2015 15:10:53 +0100 Subject: 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 Signed-off-by: Junio C Hamano --- Documentation/git-branch.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'Documentation/git-branch.txt') diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index 311b33674..e496141bc 100644 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@ -193,7 +193,9 @@ start-point is either a local or remote-tracking branch. --edit-description:: Open an editor and edit the text to explain what the branch is - for, to be used by various other commands (e.g. `request-pull`). + for, to be used by various other commands (e.g. `format-patch`, + `request-pull`, and `merge` (if enabled)). Multi-line explanations + may be used. --contains []:: Only list branches which contain the specified commit (HEAD -- cgit v1.2.1