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 vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2024-05-28
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.45.1.313.g3a57aa566a
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-FMT\-MERGE\-MSG" "1" "2024\-05\-28" "Git 2\&.45\&.1\&.313\&.g3a57aa" "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 .sp
  39 .SH "DESCRIPTION"
  40 .sp
  41 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\&.
  42 .sp
  43 This command is intended mostly for internal use by scripts automatically invoking \fIgit merge\fR\&.
  44 .SH "OPTIONS"
  45 .PP
  46 \-\-log[=<n>]
  47 .RS 4
  48 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
  49 \fBmerge\&.log\fR
  50 configuration variable\&.
  51 .RE
  52 .PP
  53 \-\-no\-log
  54 .RS 4
  55 Do not list one\-line descriptions from the actual commits being merged\&.
  56 .RE
  57 .PP
  58 \-\-[no\-]summary
  59 .RS 4
  60 Synonyms to \-\-log and \-\-no\-log; these are deprecated and will be removed in the future\&.
  61 .RE
  62 .PP
  63 \-m <message>, \-\-message <message>
  64 .RS 4
  65 Use <message> instead of the branch names for the first line of the log message\&. For use with
  66 \fB\-\-log\fR\&.
  67 .RE
  68 .PP
  69 \-\-into\-name <branch>
  70 .RS 4
  71 Prepare the merge message as if merging to the branch
  72 \fB<branch>\fR, instead of the name of the real branch to which the merge is made\&.
  73 .RE
  74 .PP
  75 \-F <file>, \-\-file <file>
  76 .RS 4
  77 Take the list of merged objects from <file> instead of stdin\&.
  78 .RE
  79 .SH "CONFIGURATION"
  80 .PP
  81 merge\&.branchdesc
  82 .RS 4
  83 In addition to branch names, populate the log message with the branch description text associated with them\&. Defaults to false\&.
  84 .RE
  85 .PP
  86 merge\&.log
  87 .RS 4
  88 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\&.
  89 .RE
  90 .PP
  91 merge\&.suppressDest
  92 .RS 4
  93 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\&.
  94 .sp
  95 An element with an empty value can be used to clear the list of globs accumulated from previous configuration entries\&. When there is no
  96 \fBmerge\&.suppressDest\fR
  97 variable defined, the default value of
  98 \fBmaster\fR
  99 is used for backward compatibility\&.
 100 .RE
 101 .PP
 102 merge\&.summary
 103 .RS 4
 104 Synonym to
 105 \fBmerge\&.log\fR; this is deprecated and will be removed in the future\&.
 106 .RE
 107 .SH "EXAMPLES"
 108 .sp
 109 .if n \{\
 110 .RS 4
 111 .\}
 112 .nf
 113 $ git fetch origin master
 114 $ git fmt\-merge\-msg \-\-log <$GIT_DIR/FETCH_HEAD
 115 .fi
 116 .if n \{\
 117 .RE
 118 .\}
 119 .sp
 120 .sp
 121 Print a log message describing a merge of the "master" branch from the "origin" remote\&.
 122 .SH "SEE ALSO"
 123 .sp
 124 \fBgit-merge\fR(1)
 125 .SH "GIT"
 126 .sp
 127 Part of the \fBgit\fR(1) suite