devdocs/git/git-fmt-merge-msg.html


1
2
3
4
5
6
7
8

<h1>git-fmt-merge-msg</h1>  <h2 id="_name">Name</h2> <div class="sectionbody">  <p>git-fmt-merge-msg - Produce a merge commit message</p>  </div>   <h2 id="_synopsis">Synopsis</h2> <div class="sectionbody"> <div class="verseblock"> <pre class="content" data-language="shell">git fmt-merge-msg [-m &lt;message&gt;] [--into-name &lt;branch&gt;] [--log[=&lt;n&gt;] | --no-log]
git fmt-merge-msg [-m &lt;message&gt;] [--log[=&lt;n&gt;] | --no-log] -F &lt;file&gt;</pre> </div> </div>   <h2 id="_description">Description</h2> <div class="sectionbody">  <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 <code>&lt;merge-message&gt;</code> argument of <code>git merge</code>.</p>   <p>This command is intended mostly for internal use by scripts automatically invoking <code>git merge</code>.</p>  </div>   <h2 id="_options">Options</h2> <div class="sectionbody"> <div class="dlist"> <dl> <dt class="hdlist1" id="Documentation/git-fmt-merge-msg.txt---logltngt"> --log[=&lt;n&gt;] </dt> <dd> <p>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 <code>merge.log</code> configuration variable.</p> </dd> <dt class="hdlist1" id="Documentation/git-fmt-merge-msg.txt---no-log"> --no-log </dt> <dd> <p>Do not list one-line descriptions from the actual commits being merged.</p> </dd> <dt class="hdlist1" id="Documentation/git-fmt-merge-msg.txt---no-summary"> --[no-]summary </dt> <dd> <p>Synonyms to --log and --no-log; these are deprecated and will be removed in the future.</p> </dd> <dt class="hdlist1" id="Documentation/git-fmt-merge-msg.txt--mltmessagegt"> -m &lt;message&gt; </dt> <dt class="hdlist1" id="Documentation/git-fmt-merge-msg.txt---messageltmessagegt"> --message &lt;message&gt; </dt> <dd> <p>Use &lt;message&gt; instead of the branch names for the first line of the log message. For use with <code>--log</code>.</p> </dd> <dt class="hdlist1" id="Documentation/git-fmt-merge-msg.txt---into-nameltbranchgt"> --into-name &lt;branch&gt; </dt> <dd> <p>Prepare the merge message as if merging to the branch <code>&lt;branch&gt;</code>, instead of the name of the real branch to which the merge is made.</p> </dd> <dt class="hdlist1" id="Documentation/git-fmt-merge-msg.txt--Fltfilegt"> -F &lt;file&gt; </dt> <dt class="hdlist1" id="Documentation/git-fmt-merge-msg.txt---fileltfilegt"> --file &lt;file&gt; </dt> <dd> <p>Take the list of merged objects from &lt;file&gt; instead of stdin.</p> </dd> </dl> </div> </div>   <h2 id="_configuration">Configuration</h2> <div class="sectionbody"> <div class="dlist"> <dl> <dt class="hdlist1" id="Documentation/git-fmt-merge-msg.txt-mergebranchdesc"> merge.branchdesc </dt> <dd> <p>In addition to branch names, populate the log message with the branch description text associated with them. Defaults to false.</p> </dd> <dt class="hdlist1" id="Documentation/git-fmt-merge-msg.txt-mergelog"> merge.log </dt> <dd> <p>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.</p> </dd> <dt class="hdlist1" id="Documentation/git-fmt-merge-msg.txt-mergesuppressDest"> merge.suppressDest </dt> <dd> <p>By adding a glob that matches the names of integration branches to this multi-valued configuration variable, the default merge message computed for merges into these integration branches will omit "into &lt;branch name&gt;" from its title.</p>  <p>An element with an empty value can be used to clear the list of globs accumulated from previous configuration entries. When there is no <code>merge.suppressDest</code> variable defined, the default value of <code>master</code> is used for backward compatibility.</p>  </dd> <dt class="hdlist1" id="Documentation/git-fmt-merge-msg.txt-mergesummary"> merge.summary </dt> <dd> <p>Synonym to <code>merge.log</code>; this is deprecated and will be removed in the future.</p> </dd> </dl> </div> </div>   <h2 id="_examples">Examples</h2> <div class="sectionbody"> <div class="listingblock"> <div class="content"> <pre data-language="shell-session">$ git fetch origin master
$ git fmt-merge-msg --log &lt;$GIT_DIR/FETCH_HEAD</pre> </div> </div>  <p>Print a log message describing a merge of the "master" branch from the "origin" remote.</p>  </div>   <h2 id="_see_also">See also</h2> <div class="sectionbody">  <p><a href="git-merge">git-merge[1]</a></p>  </div><div class="_attribution">
  <p class="_attribution-p">
    &copy; 2012&ndash;2024 Scott Chacon and others<br>Licensed under the MIT License.<br>
    <a href="https://git-scm.com/docs/git-fmt-merge-msg" class="_attribution-link">https://git-scm.com/docs/git-fmt-merge-msg</a>
  </p>
</div>