undef/git-commit-vandalism
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/git-branch.txt
View File

@ -193,7 +193,9 @@ start-point is either a local or remote-tracking branch.
--edit-description:: --edit-description::
Open an editor and edit the text to explain what the branch is 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>]:: --contains [<commit>]::
Only list branches which contain the specified commit (HEAD Only list branches which contain the specified commit (HEAD

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

@ -213,7 +213,7 @@ feeding the result to `git send-email`.
--[no-]cover-letter:: --[no-]cover-letter::
In addition to the patches, generate a cover letter file 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. fill in a description in the file before sending it out.
--notes[=<ref>]:: --notes[=<ref>]::

2
Documentation/git-merge.txt
View File

@ -78,7 +78,7 @@ will be appended to the specified message.
+ +
The 'git fmt-merge-msg' command can be The 'git fmt-merge-msg' command can be
used to give a good default for automated 'git merge' used to give a good default for automated 'git merge'
invocations. invocations. The automated message can include the branch description.
--[no-]rerere-autoupdate:: --[no-]rerere-autoupdate::
Allow the rerere mechanism to update the index with the Allow the rerere mechanism to update the index with the

3
Documentation/git-request-pull.txt
View File

@ -14,7 +14,8 @@ DESCRIPTION
----------- -----------
Generate a request asking your upstream project to pull changes into 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 changes and indicates from where they can be pulled.
The upstream project is expected to have the commit named by The upstream project is expected to have the commit named by