From 78cab9071e3d94897a40413a8f70fe18a2733f6a Mon Sep 17 00:00:00 2001 From: Frantisek Hrbata Date: Fri, 18 Dec 2020 17:42:46 +0100 Subject: [PATCH] doc: add git-mr-merge description Signed-off-by: Frantisek Hrbata --- Documentation/git-mr-merge.txt | 47 ++++++++++++++++++++++++++++++++++++++++ Documentation/git-mr.txt | 1 + 2 files changed, 48 insertions(+) create mode 100644 Documentation/git-mr-merge.txt 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)] -- 1.7.10.4