diff options
Diffstat (limited to 'Documentation/git-fmt-merge-msg.txt')
| -rw-r--r-- | Documentation/git-fmt-merge-msg.txt | 59 |
1 files changed, 37 insertions, 22 deletions
diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt index 7088ed4095..3a0f55ec8e 100644 --- a/Documentation/git-fmt-merge-msg.txt +++ b/Documentation/git-fmt-merge-msg.txt @@ -9,54 +9,69 @@ git-fmt-merge-msg - Produce a merge commit message SYNOPSIS -------- [verse] -git-fmt-merge-msg [--summary | --no-summary] <$GIT_DIR/FETCH_HEAD -git-fmt-merge-msg [--summary | --no-summary] -F <file> +'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --no-log] <$GIT_DIR/FETCH_HEAD +'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --no-log] -F <file> DESCRIPTION ----------- 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 '<merge-message>' argument of `git-merge`. +passed as the '<merge-message>' argument of 'git merge'. -This script is intended mostly for internal use by scripts -automatically invoking `git-merge`. +This command is intended mostly for internal use by scripts +automatically invoking 'git merge'. OPTIONS ------- ---summary:: +--log[=<n>]:: In addition to branch names, populate the log message with one-line descriptions from the actual commits that are being - merged. + merged. At most <n> commits from each merge parent will be + used (20 if <n> is omitted). This overrides the `merge.log` + configuration variable. ---no-summary:: +--no-log:: Do not list one-line descriptions from the actual commits being merged. ---file <file>, -F <file>:: +--summary:: +--no-summary:: + Synonyms to --log and --no-log; these are deprecated and will be + removed in the future. + +-m <message>:: +--message <message>:: + Use <message> instead of the branch names for the first line + of the log message. For use with `--log`. + +-F <file>:: +--file <file>:: Take the list of merged objects from <file> instead of stdin. CONFIGURATION ------------- +merge.branchdesc:: + In addition to branch names, populate the log message with + the branch description text associated with them. Defaults + to false. + +merge.log:: + 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. + merge.summary:: - Whether to include summaries of merged commits in newly - merge commit messages. False by default. + Synonym to `merge.log`; this is deprecated and will be removed in + the future. SEE ALSO -------- -gitlink:git-merge[1] - - -Author ------- -Written by Junio C Hamano <junkio@cox.net> - -Documentation --------------- -Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>. +linkgit:git-merge[1] GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[1] suite |