diff options
| author | Junio C Hamano <gitster@pobox.com> | 2015-09-17 12:29:03 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2015-09-17 12:29:03 -0700 |
| commit | a2654356d4ef9ffac4adda2b053d45def8e0a45c (patch) | |
| tree | 6ff033bb7dea1c5afa9db2bddf153920fe6d01fd | |
| parent | 8d45eefe3ee6bf8499221761df1ee80ead2c8fc0 (diff) | |
| parent | 561d2b7934caaa5e0917979da82ca59b17a4e5f9 (diff) | |
| download | git-a2654356d4ef9ffac4adda2b053d45def8e0a45c.tar.gz | |
Merge branch 'po/doc-branch-desc'
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
| -rw-r--r-- | Documentation/git-branch.txt | 4 | ||||
| -rw-r--r-- | Documentation/git-format-patch.txt | 2 | ||||
| -rw-r--r-- | Documentation/git-merge.txt | 2 | ||||
| -rw-r--r-- | Documentation/git-request-pull.txt | 3 |
4 files changed, 7 insertions, 4 deletions
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index a67138a022..bbbade4f51 100644 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@ -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 diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index 0dac4e9b86..4035649117 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -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>]:: diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt index 273a1009be..a62d6729b9 100644 --- a/Documentation/git-merge.txt +++ b/Documentation/git-merge.txt @@ -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 diff --git a/Documentation/git-request-pull.txt b/Documentation/git-request-pull.txt index 283577b0b6..c32cb0bea1 100644 --- a/Documentation/git-request-pull.txt +++ b/Documentation/git-request-pull.txt @@ -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 |