git-fmt-merge-msg(1)

1GIT-FMT-MERGE-MSG(1)              Git Manual              GIT-FMT-MERGE-MSG(1)
2
3
4

NAME

6       git-fmt-merge-msg - Produce a merge commit message
7

SYNOPSIS

9       git fmt-merge-msg [-m <message>] [--into-name <branch>] [--log[=<n>] | --no-log]
10       git fmt-merge-msg [-m <message>] [--log[=<n>] | --no-log] -F <file>
11

DESCRIPTION

13       Takes the list of merged objects on stdin and produces a suitable
14       commit message to be used for the merge commit, usually to be passed as
15       the <merge-message> argument of git merge.
16
17       This command is intended mostly for internal use by scripts
18       automatically invoking git merge.
19

OPTIONS

21       --log[=<n>]
22           In addition to branch names, populate the log message with one-line
23           descriptions from the actual commits that are being merged. At most
24           <n> commits from each merge parent will be used (20 if <n> is
25           omitted). This overrides the merge.log configuration variable.
26
27       --no-log
28           Do not list one-line descriptions from the actual commits being
29           merged.
30
31       --[no-]summary
32           Synonyms to --log and --no-log; these are deprecated and will be
33           removed in the future.
34
35       -m <message>, --message <message>
36           Use <message> instead of the branch names for the first line of the
37           log message. For use with --log.
38
39       --into-name <branch>
40           Prepare the merge message as if merging to the branch <branch>,
41           instead of the name of the real branch to which the merge is made.
42
43       -F <file>, --file <file>
44           Take the list of merged objects from <file> instead of stdin.
45

CONFIGURATION

47       merge.branchdesc
48           In addition to branch names, populate the log message with the
49           branch description text associated with them. Defaults to false.
50
51       merge.log
52           In addition to branch names, populate the log message with at most
53           the specified number of one-line descriptions from the actual
54           commits that are being merged. Defaults to false, and true is a
55           synonym for 20.
56
57       merge.suppressDest
58           By adding a glob that matches the names of integration branches to
59           this multi-valued configuration variable, the default merge message
60           computed for merges into these integration branches will omit "into
61           <branch name>" from its title.
62
63           An element with an empty value can be used to clear the list of
64           globs accumulated from previous configuration entries. When there
65           is no merge.suppressDest variable defined, the default value of
66           master is used for backward compatibility.
67
68       merge.summary
69           Synonym to merge.log; this is deprecated and will be removed in the
70           future.
71

EXAMPLES

73           $ git fetch origin master
74           $ git fmt-merge-msg --log <$GIT_DIR/FETCH_HEAD
75
76       Print a log message describing a merge of the "master" branch from the
77       "origin" remote.
78

GIT

83       Part of the git(1) suite
84
85
86
87Git 2.43.0                        11/20/2023              GIT-FMT-MERGE-MSG(1)