man-pages/man1/git-fmt-merge-msg.1.html
2021-03-31 01:06:50 +01:00

168 lines
3.7 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of GIT-FMT-MERGE-MSG</TITLE>
</HEAD><BODY>
<H1>GIT-FMT-MERGE-MSG</H1>
Section: Git Manual (1)<BR>Updated: 03/04/2021<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
git-fmt-merge-msg - Produce a merge commit message
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<P>
<PRE>
<I>git fmt-merge-msg</I> [-m &lt;message&gt;] [--log[=&lt;n&gt;] | --no-log]
<I>git fmt-merge-msg</I> [-m &lt;message&gt;] [--log[=&lt;n&gt;] | --no-log] -F &lt;file&gt;
</PRE>
<P>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
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 <I>&lt;merge-message&gt;</I> argument of <I>git merge</I>.
<P>
This command is intended mostly for internal use by scripts automatically invoking <I>git merge</I>.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<P>
--log[=&lt;n&gt;]
<DL COMPACT><DT id="1"><DD>
In addition to branch names, populate the log message with one-line descriptions from the actual commits that are being merged. At most &lt;n&gt; commits from each merge parent will be used (20 if &lt;n&gt; is omitted). This overrides the
<B>merge.log</B>
configuration variable.
</DL>
<P>
--no-log
<DL COMPACT><DT id="2"><DD>
Do not list one-line descriptions from the actual commits being merged.
</DL>
<P>
--[no-]summary
<DL COMPACT><DT id="3"><DD>
Synonyms to --log and --no-log; these are deprecated and will be removed in the future.
</DL>
<P>
-m &lt;message&gt;, --message &lt;message&gt;
<DL COMPACT><DT id="4"><DD>
Use &lt;message&gt; instead of the branch names for the first line of the log message. For use with
<B>--log</B>.
</DL>
<P>
-F &lt;file&gt;, --file &lt;file&gt;
<DL COMPACT><DT id="5"><DD>
Take the list of merged objects from &lt;file&gt; instead of stdin.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>CONFIGURATION</H2>
<P>
merge.branchdesc
<DL COMPACT><DT id="6"><DD>
In addition to branch names, populate the log message with the branch description text associated with them. Defaults to false.
</DL>
<P>
merge.log
<DL COMPACT><DT id="7"><DD>
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.
</DL>
<P>
merge.summary
<DL COMPACT><DT id="8"><DD>
Synonym to
<B>merge.log</B>; this is deprecated and will be removed in the future.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>EXAMPLES</H2>
<P>
<DL COMPACT><DT id="9"><DD>
<PRE>
$ git fetch origin master
$ git fmt-merge-msg --log &lt;$GIT_DIR/FETCH_HEAD
</PRE>
</DL>
<P>
<P>
Print a log message describing a merge of the &quot;master&quot; branch from the &quot;origin&quot; remote.
<A NAME="lbAH">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<B><A HREF="/cgi-bin/man/man2html?1+git-merge">git-merge</A></B>(1)
<A NAME="lbAI">&nbsp;</A>
<H2>GIT</H2>
<P>
Part of the <B><A HREF="/cgi-bin/man/man2html?1+git">git</A></B>(1) suite
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="10"><A HREF="#lbAB">NAME</A><DD>
<DT id="11"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="12"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="13"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="14"><A HREF="#lbAF">CONFIGURATION</A><DD>
<DT id="15"><A HREF="#lbAG">EXAMPLES</A><DD>
<DT id="16"><A HREF="#lbAH">SEE ALSO</A><DD>
<DT id="17"><A HREF="#lbAI">GIT</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:14 GMT, March 31, 2021
</BODY>
</HTML>