summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2013-04-03 08:36:52 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2013-04-03 08:36:52 -0700
commit0311e373b5f26f89ec65f0fbcebeba4fd68f4ad0 (patch)
tree24451326bd76faccb43505488f313ceb61359293
parentMerge branch 'ap/maint-update-index-h-is-for-help' into maint-1.8.1 (diff)
parentDocumentation: merging a tag is a special case (diff)
downloadtgif-0311e373b5f26f89ec65f0fbcebeba4fd68f4ad0.tar.xz
Merge branch 'yd/doc-merge-annotated-tag' into maint-1.8.1
* yd/doc-merge-annotated-tag: Documentation: merging a tag is a special case
-rw-r--r--Documentation/git-merge.txt24
-rw-r--r--Documentation/merge-options.txt3
2 files changed, 26 insertions, 1 deletions
diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index d34ea3c50b..7780863398 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -170,6 +170,30 @@ happens:
If you tried a merge which resulted in complex conflicts and
want to start over, you can recover with `git merge --abort`.
+MERGING TAG
+-----------
+
+When merging an annotated (and possibly signed) tag, Git always
+creates a merge commit even if a fast-forward merge is possible, and
+the commit message template is prepared with the tag message.
+Additionally, if the tag is signed, the signature check is reported
+as a comment in the message template. See also linkgit:git-tag[1].
+
+When you want to just integrate with the work leading to the commit
+that happens to be tagged, e.g. synchronizing with an upstream
+release point, you may not want to make an unnecessary merge commit.
+
+In such a case, you can "unwrap" the tag yourself before feeding it
+to `git merge`, or pass `--ff-only` when you do not have any work on
+your own. e.g.
+
+---
+git fetch origin
+git merge v1.2.3^0
+git merge --ff-only v1.2.3
+---
+
+
HOW CONFLICTS ARE PRESENTED
---------------------------
diff --git a/Documentation/merge-options.txt b/Documentation/merge-options.txt
index 0bcbe0ac3c..34a8445828 100644
--- a/Documentation/merge-options.txt
+++ b/Documentation/merge-options.txt
@@ -30,7 +30,8 @@ set to `no` at the beginning of them.
--no-ff::
Create a merge commit even when the merge resolves as a
- fast-forward.
+ fast-forward. This is the default behaviour when merging an
+ annotated (and possibly signed) tag.
--ff-only::
Refuse to merge and exit with a non-zero status unless the