From: Elijah Newren <newren@gmail.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>, Elijah Newren <newren@gmail.com>
Subject: [PATCH] merge-options.txt: clarify meaning of various ff-related options
Date: Tue, 27 Aug 2019 17:13:07 -0700 [thread overview]
Message-ID: <20190828001307.8042-1-newren@gmail.com> (raw)
As discovered on the mailing list, some of the descriptions of the
ff-related options were unclear. Try to be more precise with what these
options do.
Signed-off-by: Elijah Newren <newren@gmail.com>
---
I noticed this patch sitting around in one of my branches, and noticed it
wasn't upstream. I'm pretty sure I submitted it a few months back, but I
think it got lost in the cracks. Resubmitting and I'll see if I can do a
better job following up on it.
Documentation/merge-options.txt | 20 +++++++++++---------
1 file changed, 11 insertions(+), 9 deletions(-)
diff --git a/Documentation/merge-options.txt b/Documentation/merge-options.txt
index 79a00d2a4a..b39df5f126 100644
--- a/Documentation/merge-options.txt
+++ b/Documentation/merge-options.txt
@@ -40,20 +40,22 @@ set to `no` at the beginning of them.
case of a merge conflict.
--ff::
- When the merge resolves as a fast-forward, only update the branch
- pointer, without creating a merge commit. This is the default
+ When the merge can resolve as a fast-forward, do so (only
+ update the branch pointer to match the merged branch; do not
+ create a merge commit). When a fast forward update is not
+ possible, create a merge commit. This is the default
behavior.
--no-ff::
- Create a merge commit even when the merge resolves as a
- fast-forward. This is the default behaviour when merging an
- annotated (and possibly signed) tag that is not stored in
- its natural place in 'refs/tags/' hierarchy.
+ Create a merge commit even when the merge could instead resolve
+ as a fast-forward. This is the default behaviour when merging
+ an annotated (and possibly signed) tag that is not stored in its
+ natural place in 'refs/tags/' hierarchy.
--ff-only::
- Refuse to merge and exit with a non-zero status unless the
- current `HEAD` is already up to date or the merge can be
- resolved as a fast-forward.
+ When possible, resolve the merge as a fast-forward (do not
+ create a merge commit). When not possible, refuse to merge and
+ exit with a non-zero status.
-S[<keyid>]::
--gpg-sign[=<keyid>]::
--
2.23.0.38.gfc6987be7e
next reply other threads:[~2019-08-28 0:13 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-28 0:13 Elijah Newren [this message]
2019-08-28 9:05 ` [PATCH] merge-options.txt: clarify meaning of various ff-related options Sergey Organov
2019-08-28 15:51 ` [PATCH v2] " Elijah Newren
2019-08-28 18:45 ` Martin Ågren
2019-08-28 19:15 ` Sergey Organov
2019-08-28 19:53 ` Martin Ågren
2019-08-29 9:35 ` Sergey Organov
2019-08-28 22:51 ` Elijah Newren
2019-08-29 9:15 ` Sergey Organov
2019-08-28 22:57 ` [PATCH v3] " Elijah Newren
2019-08-30 19:57 ` Junio C Hamano
2019-08-30 20:16 ` Eric Sunshine
2019-08-31 0:23 ` [PATCH v4] " Elijah Newren
2019-08-30 19:45 ` [PATCH v2] " Junio C Hamano
2019-08-30 19:48 ` Elijah Newren
2019-08-30 20:27 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190828001307.8042-1-newren@gmail.com \
--to=newren@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).