summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilip Oakley <philipoakley@iee.org>2015-09-14 14:10:53 (GMT)
committerJunio C Hamano <gitster@pobox.com>2015-09-14 19:50:33 (GMT)
commit561d2b7934caaa5e0917979da82ca59b17a4e5f9 (patch)
tree73f45ac56de72ced86792d271b82c6d218d32f54
parentecad27cf98c391d5cfdc26ce0e442e02347baad0 (diff)
downloadgit-561d2b7934caaa5e0917979da82ca59b17a4e5f9.zip
git-561d2b7934caaa5e0917979da82ca59b17a4e5f9.tar.gz
git-561d2b7934caaa5e0917979da82ca59b17a4e5f9.tar.bz2
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>
-rw-r--r--Documentation/git-branch.txt4
-rw-r--r--Documentation/git-format-patch.txt2
-rw-r--r--Documentation/git-merge.txt2
-rw-r--r--Documentation/git-request-pull.txt3
4 files changed, 7 insertions, 4 deletions
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index 311b336..e496141 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
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index c0fd470..037ceb2 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 cf2c374..7366c3a 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 283577b..c32cb0b 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