Google Git
Sign in
googlers / jrn / git / ad471949f46c774fcdada93f376360057c6ec777 / . / Documentation / git-fmt-merge-msg.txt
blob: 423b6e033ba512f8a8ed6fe3f0ee6ef158dd5234 [file] [log] [blame]
Petr Baudis3c643142005-11-01 21:45:55 +0100[diff] [blame]1git-fmt-merge-msg(1)
2====================
3
4NAME
5----
6git-fmt-merge-msg - Produce a merge commit message
7
8
9SYNOPSIS
10--------
Matthias Kestenholze448ff82007-05-18 15:39:33 +0200[diff] [blame]11[verse]
Junio C Hamano33e8fc82015-10-16 11:27:42 -0700[diff] [blame]12'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --no-log]
Ramkumar Ramachandra96e94202010-09-08 23:29:54 +0530[diff] [blame]13'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --no-log] -F <file>
Petr Baudis3c643142005-11-01 21:45:55 +0100[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
Thomas Rast0b444cd2010-01-10 00:33:00 +0100[diff] [blame]19passed as the '<merge-message>' argument of 'git merge'.
Petr Baudis3c643142005-11-01 21:45:55 +0100[diff] [blame]20
Jonathan Nieder0f8a02c2009-10-09 05:16:15 -0500[diff] [blame]21This command is intended mostly for internal use by scripts
22automatically invoking 'git merge'.
Petr Baudis3c643142005-11-01 21:45:55 +0100[diff] [blame]23
Andrew Ruder2bc060c2007-04-26 23:58:57 -0500[diff] [blame]24OPTIONS
25-------
26
Ramkumar Ramachandra96e94202010-09-08 23:29:54 +0530[diff] [blame]27--log[=<n>]::
Andrew Ruder2bc060c2007-04-26 23:58:57 -0500[diff] [blame]28 In addition to branch names, populate the log message with
29 one-line descriptions from the actual commits that are being
Ramkumar Ramachandra96e94202010-09-08 23:29:54 +0530[diff] [blame]30 merged. At most <n> commits from each merge parent will be
31 used (20 if <n> is omitted). This overrides the `merge.log`
32 configuration variable.
Andrew Ruder2bc060c2007-04-26 23:58:57 -0500[diff] [blame]33
SZEDER Gábor6cd9cfe2008-04-06 03:23:45 +0200[diff] [blame]34--no-log::
Andrew Ruder2bc060c2007-04-26 23:58:57 -0500[diff] [blame]35 Do not list one-line descriptions from the actual commits being
36 merged.
37
Felipe Contreras0460ed22013-05-08 20:16:55 -0500[diff] [blame]38--[no-]summary::
SZEDER Gábor6cd9cfe2008-04-06 03:23:45 +0200[diff] [blame]39 Synonyms to --log and --no-log; these are deprecated and will be
40 removed in the future.
41
Jonathan Nieder21024402010-08-17 18:00:34 -0500[diff] [blame]42-m <message>::
43--message <message>::
44 Use <message> instead of the branch names for the first line
45 of the log message. For use with `--log`.
46
Stephan Beyer32402402008-06-08 03:36:09 +0200[diff] [blame]47-F <file>::
48--file <file>::
Andrew Ruder2bc060c2007-04-26 23:58:57 -0500[diff] [blame]49 Take the list of merged objects from <file> instead of
50 stdin.
51
52CONFIGURATION
53-------------
SZEDER Gáborfc0aa392015-05-27 23:52:23 +0200[diff] [blame]54include::fmt-merge-msg-config.txt[]
Petr Baudis3c643142005-11-01 21:45:55 +0100[diff] [blame]55
SZEDER Gábor6cd9cfe2008-04-06 03:23:45 +0200[diff] [blame]56merge.summary::
57 Synonym to `merge.log`; this is deprecated and will be removed in
58 the future.
59
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +0200[diff] [blame]60EXAMPLES
61--------
Junio C Hamano33e8fc82015-10-16 11:27:42 -0700[diff] [blame]62
Stefan Christ4259d692016-10-28 12:01:26 +0200[diff] [blame]63---------
Junio C Hamano33e8fc82015-10-16 11:27:42 -0700[diff] [blame]64$ git fetch origin master
65$ git fmt-merge-msg --log <$GIT_DIR/FETCH_HEAD
Stefan Christ4259d692016-10-28 12:01:26 +0200[diff] [blame]66---------
Junio C Hamano33e8fc82015-10-16 11:27:42 -0700[diff] [blame]67
68Print a log message describing a merge of the "master" branch from
69the "origin" remote.
70
71
Petr Baudis3c643142005-11-01 21:45:55 +0100[diff] [blame]72SEE ALSO
73--------
Dan McGee5162e692007-12-29 00:20:38 -0600[diff] [blame]74linkgit:git-merge[1]
Petr Baudis3c643142005-11-01 21:45:55 +0100[diff] [blame]75
Petr Baudis3c643142005-11-01 21:45:55 +0100[diff] [blame]76GIT
77---
Christian Couder9e1f0a82008-06-06 09:07:32 +0200[diff] [blame]78Part of the linkgit:git[1] suite