From 3c64314c4b1f90488391a0ffea2a4ed04c8f6b79 Mon Sep 17 00:00:00 2001 From: Petr Baudis Date: Tue, 1 Nov 2005 21:45:55 +0100 Subject: [PATCH] Documentation for git-fmt-merge-msg Simple description. It appears to be mostly internal command, but hey, it is (it seems) the only undocumented one, so let's fix it up... Also add a note about it to git-merge documentation. Signed-off-by: Petr Baudis Signed-off-by: Junio C Hamano --- Documentation/git-fmt-merge-msg.txt | 39 +++++++++++++++++++++++++++++++++++++ Documentation/git-merge.txt | 10 ++++++++++ 2 files changed, 49 insertions(+) create mode 100644 Documentation/git-fmt-merge-msg.txt diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt new file mode 100644 index 0000000000..a70eb3994a --- /dev/null +++ b/Documentation/git-fmt-merge-msg.txt @@ -0,0 +1,39 @@ +git-fmt-merge-msg(1) +==================== + +NAME +---- +git-fmt-merge-msg - Produce a merge commit message + + +SYNOPSIS +-------- +'git-fmt-merge-msg' <$GIT_DIR/FETCH_HEAD + +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 '' argument of `git-merge`. + +This script is intended mostly for internal use by scripts +automatically invoking `git-merge`. + + +SEE ALSO +-------- +gitlink:git-merge[1] + + +Author +------ +Written by Junio C Hamano + +Documentation +-------------- +Documentation by Petr Baudis, Junio C Hamano and the git-list . + +GIT +--- +Part of the gitlink:git[7] suite + diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt index a007a8b15a..8c9c4d87e3 100644 --- a/Documentation/git-merge.txt +++ b/Documentation/git-merge.txt @@ -28,6 +28,11 @@ OPTIONS there is no `-s` option, built-in list of strategies is used instead. +:: + The commit message to be used for the merge commit (in case + it is created). The `git-fmt-merge-msg` script can be used + to give a good default for automated `git-merge` invocations. + :: our branch head commit. @@ -37,6 +42,11 @@ OPTIONS obviously means you are trying an Octopus. +SEE ALSO +-------- +gitlink:git-fmt-merge-msg[1] + + Author ------ Written by Junio C Hamano -- 2.11.4.GIT