From: Frantisek Hrbata <frantisek@hrbata.com>
Date: Fri, 18 Dec 2020 16:42:46 +0000 (+0100)
Subject: doc: add git-mr-merge description
X-Git-Tag: v0.2~25
X-Git-Url: http://www.hrbata.com/gitweb/?a=commitdiff_plain;h=78cab9071e3d94897a40413a8f70fe18a2733f6a;p=gimrr.git

doc: add git-mr-merge description

Signed-off-by: Frantisek Hrbata <frantisek@hrbata.com>
---

diff --git a/Documentation/git-mr-merge.txt b/Documentation/git-mr-merge.txt
new file mode 100644
index 0000000..058b1f6
--- /dev/null
+++ b/Documentation/git-mr-merge.txt
@@ -0,0 +1,47 @@
+GIT-MR-MERGE(1)
+===============
+:doctype: manpage
+
+
+NAME
+----
+git-mr-merge - Merge MR to current branch
+
+
+SYNOPSIS
+--------
+*git-mr-merge* ['OPTIONS'] 'MR'
+
+
+DESCRIPTION
+-----------
+Merge 'MR' to the current branch if 'MR' base matches common ancestor found
+by 'git-merge-base'. This should prevent incorporation of unwanted changes
+in cases where the 'MR' is e.g. based atop of another 'MR', which is not
+yet merged. This check is skipped when the *-f* option is used.
+
+The merge commit message by default contains subject and description
+as provided during link:git-mr-create.html[git-mr-create(1)]. It can be
+modified if the *-e* option is used.
+
+
+OPTIONS
+-------
+*-f, --force*::
+    Proceed with the merge even if the MR base does not match git merge base.
+
+*--ff*::
+    Allow fast-forward. By default merge commit is created even for
+    fast-forward merges.
+
+*-e, --edit*::
+    Invoke an editor before committing successful mechanical merge.
+
+EXAMPLES
+--------
+`$ git mr-merge --edit MR`::
+  Merge 'MR' specified by revision to current branch and edit commit message.
+
+SEE ALSO
+--------
+link:git-mr.html[git-mr(1)]
diff --git a/Documentation/git-mr.txt b/Documentation/git-mr.txt
index 1615cc2..12fa6e7 100644
--- a/Documentation/git-mr.txt
+++ b/Documentation/git-mr.txt
@@ -81,3 +81,4 @@ link:git-mr-sendmail.html[git-mr-sendmail(1)]
 link:git-mr-update.html[git-mr-update(1)]
 link:git-mr-mbox.html[git-mr-mbox(1)]
 link:git-mr-reply.html[git-mr-reply(1)]
+link:git-mr-merge.html[git-mr-merge(1)]