From: Philip Oakley <philipoakley@iee.email>
To: git@vger.kernel.org
Subject: [PATCH 1/2] doc: fixup/squash: clarify use of <oid-hash> in subject line
Date: Mon, 25 May 2020 22:36:31 +0100 [thread overview]
Message-ID: <20200525213632.1626-2-philipoakley@iee.email> (raw)
In-Reply-To: <20200525213632.1626-1-philipoakley@iee.email>
The option to use the oid hash is buried deep within the fixup/squash
documenation. Split the paragraph so that the option choice is
more obvious.
Signed-off-by: Philip Oakley <philipoakley@iee.email>
---
The use of ellision `...` isn't great, as it gives no hint or clue,
leaving the subsequent test with a difficult explanation.
Clarify if a full oid has is required, or a unique abbreviation within
the respository, or just uniques within the rebase instruction?
This is a minimal change that sidesteps the chance to rewrite/clarify
the potential wider confusions over specifying the <commit> being
referred to in the fixup/squash process.
---
Documentation/git-rebase.txt | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index f7a6033607..dfd3d6d0ef 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -539,11 +539,13 @@ See also INCOMPATIBLE OPTIONS below.
matches the same `...`, automatically modify the todo list of rebase
-i so that the commit marked for squashing comes right after the
commit to be modified, and change the action of the moved commit
- from `pick` to `squash` (or `fixup`). A commit matches the `...` if
- the commit subject matches, or if the `...` refers to the commit's
- hash. As a fall-back, partial matches of the commit subject work,
- too. The recommended way to create fixup/squash commits is by using
- the `--fixup`/`--squash` options of linkgit:git-commit[1].
+ from `pick` to `squash` (or `fixup`).
++
+A commit matches the `...` if
+the commit subject matches, or if the `...` refers to the commit's
+hash. As a fall-back, partial matches of the commit subject work,
+too. The recommended way to create fixup/squash commits is by using
+the `--fixup`/`--squash` options of linkgit:git-commit[1].
+
If the `--autosquash` option is enabled by default using the
configuration variable `rebase.autoSquash`, this option can be
--
2.26.2.windows.1.13.g9dddff6983
next prev parent reply other threads:[~2020-05-25 21:44 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-04 20:40 [PATCH] rebase --autosquash: fix a potential segfault Johannes Schindelin via GitGitGadget
2020-05-04 21:19 ` Junio C Hamano
2020-05-04 21:33 ` Jeff King
2020-05-04 22:09 ` Taylor Blau
2020-05-05 20:30 ` Junio C Hamano
2020-05-06 21:35 ` Johannes Schindelin
2020-05-07 19:17 ` Jeff King
2020-05-08 23:45 ` Johannes Schindelin
2020-05-05 22:33 ` [PATCH v2] " Johannes Schindelin via GitGitGadget
2020-05-09 19:23 ` [PATCH v3] " Johannes Schindelin via GitGitGadget
2020-05-06 15:12 ` [PATCH] " Andrei Rybak
2020-05-07 14:27 ` Johannes Schindelin
2020-05-08 16:43 ` Philip Oakley
2020-05-08 16:57 ` Andrei Rybak
2020-05-08 17:21 ` Philip Oakley
2020-05-18 16:47 ` Philip Oakley
2020-05-18 3:27 ` Johannes Schindelin
2020-05-25 17:29 ` Philip Oakley
2020-05-25 21:36 ` [PATCH 0/2] Clarify some of the fixup! documenation Philip Oakley
2020-05-25 21:36 ` Philip Oakley [this message]
2020-05-27 17:35 ` [PATCH 1/2] doc: fixup/squash: clarify use of <oid-hash> in subject line Junio C Hamano
2020-05-29 11:41 ` Philip Oakley
2020-05-25 21:36 ` [PATCH 2/2] doc: fixup/squash: remove ellipsis marks, use <line> for clarify Philip Oakley
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=20200525213632.1626-2-philipoakley@iee.email \
--to=philipoakley@iee.email \
--cc=git@vger.kernel.org \
/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).