git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Michael Lohmann <mial.lohmann@gmail.com>
To: git@vger.kernel.org
Cc: Michael Lohmann <mi.al.lohmann@gmail.com>
Subject: [PATCH] Documentation/git-merge.txt: fix reference to synopsys
Date: Wed, 20 Dec 2023 08:05:28 +0100	[thread overview]
Message-ID: <20231220070528.8049-1-mi.al.lohmann@gmail.com> (raw)

437591a9d738 changed the synopsys from two separate lines for `--abort`
and `--continue` to a single line (and it also simultaneously added
`--quit`). That way the "enumeration" of the syntax for `--continue` is
no longer valid. Since `--quit` is now also part of the same syntax
line, a general statement cannot be made any more. Instead of trying to
enumerate the synopsys, be explicit in the limitations of when
respective actions are valid.

This change also groups `--abort` and `--continue` together when
explaining the circumstances under which they can be run in order to
avoid duplication.

Signed-off-by: Michael Lohmann <mi.al.lohmann@gmail.com>
---
 Documentation/git-merge.txt | 19 +++++++++----------
 1 file changed, 9 insertions(+), 10 deletions(-)

diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index e8ab340319..d8863cc943 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -46,21 +46,20 @@ a log message from the user describing the changes. Before the operation,
     D---E---F---G---H master
 ------------
 
-The second syntax ("`git merge --abort`") can only be run after the
-merge has resulted in conflicts. 'git merge --abort' will abort the
-merge process and try to reconstruct the pre-merge state. However,
-if there were uncommitted changes when the merge started (and
-especially if those changes were further modified after the merge
-was started), 'git merge --abort' will in some cases be unable to
-reconstruct the original (pre-merge) changes. Therefore:
+It is possible that a merge failure will prevent this process from being
+completely automatic. "`git merge --continue`" and "`git merge --abort`"
+can only be run after the merge has resulted in conflicts.
+
+'git merge --abort' will abort the merge process and try to reconstruct
+the pre-merge state. However, if there were uncommitted changes when the
+merge started (and especially if those changes were further modified
+after the merge was started), 'git merge --abort' will in some cases be
+unable to reconstruct the original (pre-merge) changes. Therefore:
 
 *Warning*: Running 'git merge' with non-trivial uncommitted changes is
 discouraged: while possible, it may leave you in a state that is hard to
 back out of in the case of a conflict.
 
-The third syntax ("`git merge --continue`") can only be run after the
-merge has resulted in conflicts.
-
 OPTIONS
 -------
 :git-merge: 1
-- 
2.39.3 (Apple Git-145)


             reply	other threads:[~2023-12-20  7:06 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-12-20  7:05 Michael Lohmann [this message]
2023-12-20 15:43 ` [PATCH] Documentation/git-merge.txt: fix reference to synopsys René Scharfe
2023-12-20 16:29   ` Elijah Newren
2023-12-20 17:18     ` René Scharfe
2023-12-20 16:51   ` Junio C Hamano
2023-12-20 19:53   ` [PATCH 0/2] Documentation/git-merge.txt: fix reference to synopsis Michael Lohmann
2023-12-20 19:53   ` [PATCH 1/2] " Michael Lohmann
2023-12-20 20:45     ` Elijah Newren
2023-12-20 20:56     ` Junio C Hamano
2023-12-20 21:35       ` [PATCH v3 " Michael Lohmann
2023-12-20 21:39         ` Junio C Hamano
2023-12-20 22:09           ` Michael Lohmann
2023-12-20 19:53   ` [PATCH 2/2] Documentation/git-merge.txt: use backticks for command wrapping Michael Lohmann

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20231220070528.8049-1-mi.al.lohmann@gmail.com \
    --to=mial.lohmann@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=mi.al.lohmann@gmail.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.
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).