Skip to content

Commit

Permalink
Merge branch 'po/doc-branch-desc'
Browse files Browse the repository at this point in the history
The branch descriptions that are set with "git branch --edit-description"
option were used in many places but they weren't clearly documented.

* po/doc-branch-desc:
  doc: show usage of branch description
  • Loading branch information
Junio C Hamano committed Sep 17, 2015
2 parents 8d45eef + 561d2b7 commit a265435
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 4 deletions.
4 changes: 3 additions & 1 deletion Documentation/git-branch.txt
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,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
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-format-patch.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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>]::
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-merge.txt
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ will be appended to the specified message.
+
The 'git fmt-merge-msg' command can be
used to give a good default for automated 'git merge'
invocations.
invocations. The automated message can include the branch description.

--[no-]rerere-autoupdate::
Allow the rerere mechanism to update the index with the
Expand Down
3 changes: 2 additions & 1 deletion Documentation/git-request-pull.txt
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ DESCRIPTION
-----------

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 upstream project is expected to have the commit named by
Expand Down

0 comments on commit a265435

Please sign in to comment.