git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Michael Lohmann <mial.lohmann@gmail.com>
To: gitster@pobox.com
Cc: Michael Lohmann <mi.al.lohmann@gmail.com>,
	git@vger.kernel.org, l.s.r@web.de, mial.lohmann@gmail.com,
	newren@gmail.com
Subject: [PATCH v3 1/2] Documentation/git-merge.txt: fix reference to synopsis
Date: Wed, 20 Dec 2023 22:35:34 +0100	[thread overview]
Message-ID: <20231220213534.18947-1-mi.al.lohmann@gmail.com> (raw)
In-Reply-To: <xmqqy1dor3t5.fsf@gitster.g>

437591a9d738 combined the synopsis of "The second syntax" (meaning `git
merge --abort`) and "The third syntax" (for `git merge --continue`) into
this single line:

       git merge (--continue | --abort | --quit)

but it was still referred to when describing the preconditions that have
to be fulfilled to run the respective actions. In other words:
References by number are no longer valid after a merge of some of the
synopses.

Also the previous version of the documentation did not acknowledge that
`--no-commit` would result in the precondition being fulfilled (thanks
to Elijah Newren and Junio C Hamano for pointing that out).

This change also groups `--abort` and `--continue` together when
explaining the prerequisites in order to avoid duplication.

Helped-by: René Scharfe <l.s.r@web.de>
Signed-off-by: Michael Lohmann <mi.al.lohmann@gmail.com>
---

@Junio My sentence was ambiguous. I wanted to refer to the upstream
version of the docs, since that also has the faulty prerequisites, so I
changed it to "the previous version of the documentation" for
clarification. If you think that this paragraph is not needed
nevertheless I am perfectly happy to remove it.

@Elijah Thanks!

 Documentation/git-merge.txt | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index e8ab340319..33ec5c6b19 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -46,21 +46,21 @@ 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:
+A merge stops if there's a conflict that cannot be resolved
+automatically or if `--no-commit` was provided when initiating the
+merge. At that point you can run `git merge --abort` or `git merge
+--continue`.
+
+`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 21:35 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-12-20  7:05 [PATCH] Documentation/git-merge.txt: fix reference to synopsys Michael Lohmann
2023-12-20 15:43 ` 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       ` Michael Lohmann [this message]
2023-12-20 21:39         ` [PATCH v3 " 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=20231220213534.18947-1-mi.al.lohmann@gmail.com \
    --to=mial.lohmann@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=l.s.r@web.de \
    --cc=mi.al.lohmann@gmail.com \
    --cc=newren@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).