mirror of
https://github.com/git/git
synced 2024-08-27 19:49:21 +00:00
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 <pasky@suse.cz> Signed-off-by: Junio C Hamano <junkio@cox.net>
This commit is contained in:
parent
e3a39000e2
commit
3c64314c4b
39
Documentation/git-fmt-merge-msg.txt
Normal file
39
Documentation/git-fmt-merge-msg.txt
Normal file
|
@ -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 '<merge-message>' 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 <junkio@cox.net>
|
||||
|
||||
Documentation
|
||||
--------------
|
||||
Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
|
||||
|
||||
GIT
|
||||
---
|
||||
Part of the gitlink:git[7] suite
|
||||
|
|
@ -28,6 +28,11 @@ OPTIONS
|
|||
there is no `-s` option, built-in list of strategies is
|
||||
used instead.
|
||||
|
||||
<msg>::
|
||||
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.
|
||||
|
||||
<head>::
|
||||
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 <junkio@cox.net>
|
||||
|
|
Loading…
Reference in a new issue