man1/git-fmt-merge-msg.1

   1 '\" t
   2 .\"     Title: git-fmt-merge-msg
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-09-30
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.47.0.rc0.18.ge9356ba3ea
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-FMT\-MERGE\-MSG" "1" "2024-09-30" "Git 2\&.47\&.0\&.rc0\&.18\&.ge" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-fmt-merge-msg \- Produce a merge commit message
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit fmt\-merge\-msg\fR [\-m <message>] [\-\-into\-name <branch>] [\-\-log[=<n>] | \-\-no\-log]
  36 \fIgit fmt\-merge\-msg\fR [\-m <message>] [\-\-log[=<n>] | \-\-no\-log] \-F <file>
  37 .fi
  38 .SH "DESCRIPTION"
  39 .sp
  40 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\&.
  41 .sp
  42 This command is intended mostly for internal use by scripts automatically invoking \fIgit merge\fR\&.
  43 .SH "OPTIONS"
  44 .PP
  45 \-\-log[=<n>]
  46 .RS 4
  47 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
  48 \fBmerge\&.log\fR
  49 configuration variable\&.
  50 .RE
  51 .PP
  52 \-\-no\-log
  53 .RS 4
  54 Do not list one\-line descriptions from the actual commits being merged\&.
  55 .RE
  56 .PP
  57 \-\-[no\-]summary
  58 .RS 4
  59 Synonyms to \-\-log and \-\-no\-log; these are deprecated and will be removed in the future\&.
  60 .RE
  61 .PP
  62 \-m <message>, \-\-message <message>
  63 .RS 4
  64 Use <message> instead of the branch names for the first line of the log message\&. For use with
  65 \fB\-\-log\fR\&.
  66 .RE
  67 .PP
  68 \-\-into\-name <branch>
  69 .RS 4
  70 Prepare the merge message as if merging to the branch
  71 \fB<branch>\fR, instead of the name of the real branch to which the merge is made\&.
  72 .RE
  73 .PP
  74 \-F <file>, \-\-file <file>
  75 .RS 4
  76 Take the list of merged objects from <file> instead of stdin\&.
  77 .RE
  78 .SH "CONFIGURATION"
  79 .PP
  80 merge\&.branchdesc
  81 .RS 4
  82 In addition to branch names, populate the log message with the branch description text associated with them\&. Defaults to false\&.
  83 .RE
  84 .PP
  85 merge\&.log
  86 .RS 4
  87 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\&.
  88 .RE
  89 .PP
  90 merge\&.suppressDest
  91 .RS 4
  92 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 <branch name>" from its title\&.
  93 .sp
  94 An element with an empty value can be used to clear the list of globs accumulated from previous configuration entries\&. When there is no
  95 \fBmerge\&.suppressDest\fR
  96 variable defined, the default value of
  97 \fBmaster\fR
  98 is used for backward compatibility\&.
  99 .RE
 100 .PP
 101 merge\&.summary
 102 .RS 4
 103 Synonym to
 104 \fBmerge\&.log\fR; this is deprecated and will be removed in the future\&.
 105 .RE
 106 .SH "EXAMPLES"
 107 .sp
 108 .if n \{\
 109 .RS 4
 110 .\}
 111 .nf
 112 $ git fetch origin master
 113 $ git fmt\-merge\-msg \-\-log <$GIT_DIR/FETCH_HEAD
 114 .fi
 115 .if n \{\
 116 .RE
 117 .\}
 118 .sp
 119 Print a log message describing a merge of the "master" branch from the "origin" remote\&.
 120 .SH "SEE ALSO"
 121 .sp
 122 \fBgit-merge\fR(1)
 123 .SH "GIT"
 124 .sp
 125 Part of the \fBgit\fR(1) suite