blob: f42842e5ed97a20632c5ad29f7ef1195cc32b219 [file] [log] [blame]
'\" t
.\" Title: git-fmt-merge-msg
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\" Date: 11/18/2018
.\" Manual: Git Manual
.\" Source: Git 2.20.0.rc0
.\" Language: English
.\"
.TH "GIT\-FMT\-MERGE\-MSG" "1" "11/18/2018" "Git 2\&.20\&.0\&.rc0" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
git-fmt-merge-msg \- Produce a merge commit message
.SH "SYNOPSIS"
.sp
.nf
\fIgit fmt\-merge\-msg\fR [\-m <message>] [\-\-log[=<n>] | \-\-no\-log]
\fIgit fmt\-merge\-msg\fR [\-m <message>] [\-\-log[=<n>] | \-\-no\-log] \-F <file>
.fi
.sp
.SH "DESCRIPTION"
.sp
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 \fI<merge\-message>\fR argument of \fIgit merge\fR\&.
.sp
This command is intended mostly for internal use by scripts automatically invoking \fIgit merge\fR\&.
.SH "OPTIONS"
.PP
\-\-log[=<n>]
.RS 4
In addition to branch names, populate the log message with one\-line descriptions from the actual commits that are being merged\&. At most <n> commits from each merge parent will be used (20 if <n> is omitted)\&. This overrides the
\fBmerge\&.log\fR
configuration variable\&.
.RE
.PP
\-\-no\-log
.RS 4
Do not list one\-line descriptions from the actual commits being merged\&.
.RE
.PP
\-\-[no\-]summary
.RS 4
Synonyms to \-\-log and \-\-no\-log; these are deprecated and will be removed in the future\&.
.RE
.PP
\-m <message>, \-\-message <message>
.RS 4
Use <message> instead of the branch names for the first line of the log message\&. For use with
\fB\-\-log\fR\&.
.RE
.PP
\-F <file>, \-\-file <file>
.RS 4
Take the list of merged objects from <file> instead of stdin\&.
.RE
.SH "CONFIGURATION"
.PP
merge\&.branchdesc
.RS 4
In addition to branch names, populate the log message with the branch description text associated with them\&. Defaults to false\&.
.RE
.PP
merge\&.log
.RS 4
In addition to branch names, populate the log message with at most the specified number of one\-line descriptions from the actual commits that are being merged\&. Defaults to false, and true is a synonym for 20\&.
.RE
.PP
merge\&.summary
.RS 4
Synonym to
\fBmerge\&.log\fR; this is deprecated and will be removed in the future\&.
.RE
.SH "EXAMPLES"
.sp
.if n \{\
.RS 4
.\}
.nf
$ git fetch origin master
$ git fmt\-merge\-msg \-\-log <$GIT_DIR/FETCH_HEAD
.fi
.if n \{\
.RE
.\}
.sp
.sp
Print a log message describing a merge of the "master" branch from the "origin" remote\&.
.SH "SEE ALSO"
.sp
\fBgit-merge\fR(1)
.SH "GIT"
.sp
Part of the \fBgit\fR(1) suite