* [PATCH] Documentation for git-fmt-merge-msg
@ 2005-11-01 20:45 Petr Baudis
0 siblings, 0 replies; only message in thread
From: Petr Baudis @ 2005-11-01 20:45 UTC (permalink / raw)
To: Junio C Hamano; +Cc: git
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>
---
Documentation/git-fmt-merge-msg.txt | 39 +++++++++++++++++++++++++++++++++++
Documentation/git-merge.txt | 10 +++++++++
2 files changed, 49 insertions(+), 0 deletions(-)
diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
new file mode 100644
index 0000000..a70eb39
--- /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 '<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
+
diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index a007a8b..8c9c4d8 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.
+<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>
^ permalink raw reply related [flat|nested] only message in thread
only message in thread, other threads:[~2005-11-01 20:46 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2005-11-01 20:45 [PATCH] Documentation for git-fmt-merge-msg Petr Baudis
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).