diff options
| author | Philip Oakley <philipoakley@iee.org> | 2015-09-14 15:10:53 +0100 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2015-09-14 12:50:33 -0700 |
| commit | 561d2b7934caaa5e0917979da82ca59b17a4e5f9 (patch) | |
| tree | 73f45ac56de72ced86792d271b82c6d218d32f54 /Documentation/git-branch.txt | |
| parent | ecad27cf98c391d5cfdc26ce0e442e02347baad0 (diff) | |
| download | git-561d2b7934caaa5e0917979da82ca59b17a4e5f9.tar.gz | |
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-branch.txt')
| -rw-r--r-- | Documentation/git-branch.txt | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index 311b33674e..e496141bc5 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 [<commit>]:: Only list branches which contain the specified commit (HEAD |