Merge branch 'jm/maint-gitweb-filter-forks-fix'
[gitweb.git] / Documentation / merge-options.txt
index 007909a82fe77325e46c54799d00dc78493a47f9..6bd0b041c3c1c0af5d03fce43d8016706e9256b1 100644 (file)
@@ -1,60 +1,97 @@
---stat::
-       Show a diffstat at the end of the merge. The diffstat is also
-       controlled by the configuration option merge.stat.
+--commit::
+--no-commit::
+       Perform the merge and commit the result. This option can
+       be used to override --no-commit.
++
+With --no-commit perform the merge but pretend the merge
+failed and do not autocommit, to give the user a chance to
+inspect and further tweak the merge result before committing.
 
--n::
---no-stat::
-       Do not show diffstat at the end of the merge.
+--edit::
+-e::
++
+       Invoke editor before committing successful merge to further
+       edit the default merge message.
 
---summary::
---no-summary::
-       Synonyms to --stat and --no-stat; these are deprecated and will be
-       removed in the future.
-
---log::
-       In addition to branch names, populate the log message with
-       one-line descriptions from the actual commits that are being
-       merged.
+--ff::
+--no-ff::
+       Do not generate a merge commit if the merge resolved as
+       a fast-forward, only update the branch pointer. This is
+       the default behavior of git-merge.
++
+With --no-ff Generate a merge commit even if the merge
+resolved as a fast-forward.
 
+--log[=<n>]::
 --no-log::
-       Do not list one-line descriptions from the actual commits being
-       merged.
+       In addition to branch names, populate the log message with
+       one-line descriptions from at most <n> actual commits that are being
+       merged. See also linkgit:git-fmt-merge-msg[1].
++
+With --no-log do not list one-line descriptions from the
+actual commits being merged.
 
---no-commit::
-       Perform the merge but pretend the merge failed and do
-       not autocommit, to give the user a chance to inspect and
-       further tweak the merge result before committing.
 
---commit::
-       Perform the merge and commit the result. This option can
-       be used to override --no-commit.
+--stat::
+-n::
+--no-stat::
+       Show a diffstat at the end of the merge. The diffstat is also
+       controlled by the configuration option merge.stat.
++
+With -n or --no-stat do not show a diffstat at the end of the
+merge.
 
 --squash::
+--no-squash::
        Produce the working tree and index state as if a real
-       merge happened, but do not actually make a commit or
+       merge happened (except for the merge information),
+       but do not actually make a commit or
        move the `HEAD`, nor record `$GIT_DIR/MERGE_HEAD` to
        cause the next `git commit` command to create a merge
        commit.  This allows you to create a single commit on
        top of the current branch whose effect is the same as
        merging another branch (or more in case of an octopus).
++
+With --no-squash perform the merge and commit the result. This
+option can be used to override --squash.
 
---no-squash::
-       Perform the merge and commit the result. This option can
-       be used to override --squash.
-
---no-ff::
-       Generate a merge commit even if the merge resolved as a
-       fast-forward.
-
---ff::
-       Do not generate a merge commit if the merge resolved as
-       a fast-forward, only update the branch pointer. This is
-       the default behavior of git-merge.
+--ff-only::
+       Refuse to merge and exit with a non-zero status unless the
+       current `HEAD` is already up-to-date or the merge can be
+       resolved as a fast-forward.
 
 -s <strategy>::
 --strategy=<strategy>::
        Use the given merge strategy; can be supplied more than
        once to specify them in the order they should be tried.
        If there is no `-s` option, a built-in list of strategies
-       is used instead ('git-merge-recursive' when merging a single
-       head, 'git-merge-octopus' otherwise).
+       is used instead ('git merge-recursive' when merging a single
+       head, 'git merge-octopus' otherwise).
+
+-X <option>::
+--strategy-option=<option>::
+       Pass merge strategy specific option through to the merge
+       strategy.
+
+--summary::
+--no-summary::
+       Synonyms to --stat and --no-stat; these are deprecated and will be
+       removed in the future.
+
+ifndef::git-pull[]
+-q::
+--quiet::
+       Operate quietly. Implies --no-progress.
+
+-v::
+--verbose::
+       Be verbose.
+
+--progress::
+--no-progress::
+       Turn progress on/off explicitly. If neither is specified,
+       progress is shown if standard error is connected to a terminal.
+       Note that not all merge strategies may support progress
+       reporting.
+
+endif::git-pull[]