Skip to content

Commit 561d2b7

Browse files
Philip Oakleygitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent ecad27c commit 561d2b7

File tree

4 files changed

+7
-4
lines changed

4 files changed

+7
-4
lines changed

Documentation/git-branch.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,9 @@ start-point is either a local or remote-tracking branch.
193193

194194
--edit-description::
195195
Open an editor and edit the text to explain what the branch is
196-
for, to be used by various other commands (e.g. `request-pull`).
196+
for, to be used by various other commands (e.g. `format-patch`,
197+
`request-pull`, and `merge` (if enabled)). Multi-line explanations
198+
may be used.
197199

198200
--contains [<commit>]::
199201
Only list branches which contain the specified commit (HEAD

Documentation/git-format-patch.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ feeding the result to `git send-email`.
213213

214214
--[no-]cover-letter::
215215
In addition to the patches, generate a cover letter file
216-
containing the shortlog and the overall diffstat. You can
216+
containing the branch description, shortlog and the overall diffstat. You can
217217
fill in a description in the file before sending it out.
218218

219219
--notes[=<ref>]::

Documentation/git-merge.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ will be appended to the specified message.
7878
+
7979
The 'git fmt-merge-msg' command can be
8080
used to give a good default for automated 'git merge'
81-
invocations.
81+
invocations. The automated message can include the branch description.
8282

8383
--[no-]rerere-autoupdate::
8484
Allow the rerere mechanism to update the index with the

Documentation/git-request-pull.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ DESCRIPTION
1414
-----------
1515

1616
Generate a request asking your upstream project to pull changes into
17-
their tree. The request, printed to the standard output, summarizes
17+
their tree. The request, printed to the standard output,
18+
begins with the branch description, summarizes
1819
the changes and indicates from where they can be pulled.
1920

2021
The upstream project is expected to have the commit named by

0 commit comments

Comments
 (0)