summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2007-10-30 18:54:11 (GMT)
committerJunio C Hamano <gitster@pobox.com>2007-10-30 23:33:55 (GMT)
commitdee48c3c7ed7f7a32a524e8a492c6bc4e3c1c78d (patch)
tree54c57ac2544d2fbbe9a2d1d34c676c3d31625548
parentb6c9fb5100f8cd4081f1c6df5aea7335a11e9659 (diff)
downloadgit-dee48c3c7ed7f7a32a524e8a492c6bc4e3c1c78d.zip
git-dee48c3c7ed7f7a32a524e8a492c6bc4e3c1c78d.tar.gz
git-dee48c3c7ed7f7a32a524e8a492c6bc4e3c1c78d.tar.bz2
git-merge: document but discourage the historical syntax
Historically "git merge" took its command line arguments in a rather strange order. Document the historical syntax, and also document clearly that it is not encouraged in new scripts. There is no reason to deprecate the historical syntax, as the current code can sanely tell which syntax the caller is using, and existing scripts by people do use the historical syntax. Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/git-merge.txt11
1 files changed, 6 insertions, 5 deletions
diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index eae49c4..827838f 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -11,26 +11,27 @@ SYNOPSIS
[verse]
'git-merge' [-n] [--summary] [--no-commit] [--squash] [-s <strategy>]...
[-m <msg>] <remote> <remote>...
+'git-merge' <msg> HEAD <remote>...
DESCRIPTION
-----------
This is the top-level interface to the merge machinery
which drives multiple merge strategy scripts.
+The second syntax (<msg> `HEAD` <remote>) is supported for
+historical reasons. Do not use it from the command line or in
+new scripts. It is the same as `git merge -m <msg> <remote>`.
+
OPTIONS
-------
include::merge-options.txt[]
-<msg>::
+-m <msg>::
The commit message to be used for the merge commit (in case
it is created). The `git-fmt-merge-msg` script can be used
to give a good default for automated `git-merge` invocations.
-<head>::
- Our branch head commit. This has to be `HEAD`, so new
- syntax does not require it
-
<remote>::
Other branch head merged into our branch. You need at
least one <remote>. Specifying more than one <remote>