Google Git
Sign in
chromium / external / gitster / git-htmldocs / f9a7457170b72c7923ec935bde0bc64ba6e8b148 / . / git-fmt-merge-msg.txt
blob: 6526b178e87f9cbf1c2032bd63023295cf1d190e [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1git-fmt-merge-msg(1)
2====================
3
4NAME
5----
6git-fmt-merge-msg - Produce a merge commit message
7
8
9SYNOPSIS
10--------
Junio C Hamanoa9b8d242007-05-19 04:51:55[diff] [blame]11[verse]
Junio C Hamanodaf0aae2015-10-26 23:14:30[diff] [blame]12'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --no-log]
Junio C Hamano3b4609d2010-09-30 00:04:34[diff] [blame]13'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --no-log] -F <file>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]14
15DESCRIPTION
16-----------
17Takes the list of merged objects on stdin and produces a suitable
18commit message to be used for the merge commit, usually to be
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]19passed as the '<merge-message>' argument of 'git merge'.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]20
Junio C Hamanoc0e55e72009-10-10 00:56:29[diff] [blame]21This command is intended mostly for internal use by scripts
22automatically invoking 'git merge'.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]23
Junio C Hamano9882a522007-04-27 08:22:22[diff] [blame]24OPTIONS
25-------
26
Junio C Hamano3b4609d2010-09-30 00:04:34[diff] [blame]27--log[=<n>]::
Junio C Hamano9882a522007-04-27 08:22:22[diff] [blame]28In addition to branch names, populate the log message with
29one-line descriptions from the actual commits that are being
Junio C Hamano3b4609d2010-09-30 00:04:34[diff] [blame]30merged. At most <n> commits from each merge parent will be
31used (20 if <n> is omitted). This overrides the `merge.log`
32configuration variable.
Junio C Hamano9882a522007-04-27 08:22:22[diff] [blame]33
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]34--no-log::
Junio C Hamano9882a522007-04-27 08:22:22[diff] [blame]35Do not list one-line descriptions from the actual commits being
36merged.
37
Junio C Hamano3d1b5a12013-05-17 23:34:02[diff] [blame]38--[no-]summary::
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]39Synonyms to --log and --no-log; these are deprecated and will be
40removed in the future.
41
Junio C Hamano2db3e752010-09-03 21:33:06[diff] [blame]42-m <message>::
43--message <message>::
44Use <message> instead of the branch names for the first line
45of the log message. For use with `--log`.
46
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]47-F <file>::
48--file <file>::
Junio C Hamano9882a522007-04-27 08:22:22[diff] [blame]49Take the list of merged objects from <file> instead of
50stdin.
51
52CONFIGURATION
53-------------
Junio C Hamanoce447ab2015-06-16 22:08:01[diff] [blame]54include::fmt-merge-msg-config.txt[]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]55
Junio C Hamano6d76d612008-05-09 05:46:08[diff] [blame]56merge.summary::
57Synonym to `merge.log`; this is deprecated and will be removed in
58the future.
59
Junio C Hamanodaf0aae2015-10-26 23:14:30[diff] [blame]60EXAMPLE
61-------
62
63--
64$ git fetch origin master
65$ git fmt-merge-msg --log <$GIT_DIR/FETCH_HEAD
66--
67
68Print a log message describing a merge of the "master" branch from
69the "origin" remote.
70
71
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]72SEE ALSO
73--------
Junio C Hamano35738e82008-01-07 07:55:46[diff] [blame]74linkgit:git-merge[1]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]75
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]76GIT
77---
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]78Part of the linkgit:git[1] suite