Sync with 1.8.1.5
[git/jnareb-git.git] / Documentation / git-fmt-merge-msg.txt
blob3a0f55ec8e273545af3a92a9b886511ac79ba73c
1 git-fmt-merge-msg(1)
2 ====================
4 NAME
5 ----
6 git-fmt-merge-msg - Produce a merge commit message
9 SYNOPSIS
10 --------
11 [verse]
12 'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --no-log] <$GIT_DIR/FETCH_HEAD
13 'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --no-log] -F <file>
15 DESCRIPTION
16 -----------
17 Takes the list of merged objects on stdin and produces a suitable
18 commit message to be used for the merge commit, usually to be
19 passed as the '<merge-message>' argument of 'git merge'.
21 This command is intended mostly for internal use by scripts
22 automatically invoking 'git merge'.
24 OPTIONS
25 -------
27 --log[=<n>]::
28         In addition to branch names, populate the log message with
29         one-line descriptions from the actual commits that are being
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.
34 --no-log::
35         Do not list one-line descriptions from the actual commits being
36         merged.
38 --summary::
39 --no-summary::
40         Synonyms to --log and --no-log; these are deprecated and will be
41         removed in the future.
43 -m <message>::
44 --message <message>::
45         Use <message> instead of the branch names for the first line
46         of the log message.  For use with `--log`.
48 -F <file>::
49 --file <file>::
50         Take the list of merged objects from <file> instead of
51         stdin.
53 CONFIGURATION
54 -------------
56 merge.branchdesc::
57         In addition to branch names, populate the log message with
58         the branch description text associated with them.  Defaults
59         to false.
61 merge.log::
62         In addition to branch names, populate the log message with at
63         most the specified number of one-line descriptions from the
64         actual commits that are being merged.  Defaults to false, and
65         true is a synonym for 20.
67 merge.summary::
68         Synonym to `merge.log`; this is deprecated and will be removed in
69         the future.
71 SEE ALSO
72 --------
73 linkgit:git-merge[1]
75 GIT
76 ---
77 Part of the linkgit:git[1] suite