summaryrefslogtreecommitdiff
path: root/Documentation/git-fmt-merge-msg.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/git-fmt-merge-msg.txt')
-rw-r--r--Documentation/git-fmt-merge-msg.txt47
1 files changed, 40 insertions, 7 deletions
diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
index a70eb3994a..1c24796d66 100644
--- a/Documentation/git-fmt-merge-msg.txt
+++ b/Documentation/git-fmt-merge-msg.txt
@@ -8,26 +8,60 @@ git-fmt-merge-msg - Produce a merge commit message
SYNOPSIS
--------
-'git-fmt-merge-msg' <$GIT_DIR/FETCH_HEAD
+[verse]
+'git fmt-merge-msg' [--log | --no-log] <$GIT_DIR/FETCH_HEAD
+'git fmt-merge-msg' [--log | --no-log] -F <file>
DESCRIPTION
-----------
Takes the list of merged objects on stdin and produces a suitable
commit message to be used for the merge commit, usually to be
-passed as the '<merge-message>' argument of `git-merge`.
+passed as the '<merge-message>' argument of 'git-merge'.
This script is intended mostly for internal use by scripts
-automatically invoking `git-merge`.
+automatically invoking 'git-merge'.
+OPTIONS
+-------
+
+--log::
+ In addition to branch names, populate the log message with
+ one-line descriptions from the actual commits that are being
+ merged.
+
+--no-log::
+ Do not list one-line descriptions from the actual commits being
+ merged.
+
+--summary::
+--no-summary::
+ Synonyms to --log and --no-log; these are deprecated and will be
+ removed in the future.
+
+-F <file>::
+--file <file>::
+ Take the list of merged objects from <file> instead of
+ stdin.
+
+CONFIGURATION
+-------------
+
+merge.log::
+ Whether to include summaries of merged commits in newly
+ merge commit messages. False by default.
+
+merge.summary::
+ Synonym to `merge.log`; this is deprecated and will be removed in
+ the future.
SEE ALSO
--------
-gitlink:git-merge[1]
+linkgit:git-merge[1]
Author
------
-Written by Junio C Hamano <junkio@cox.net>
+Written by Junio C Hamano <gitster@pobox.com>
Documentation
--------------
@@ -35,5 +69,4 @@ Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.o
GIT
---
-Part of the gitlink:git[7] suite
-
+Part of the linkgit:git[1] suite