diff mbox series

[2/2] doc: fixup/squash: remove ellipsis marks, use <line> for clarify

Message ID 20200525213632.1626-3-philipoakley@iee.email (mailing list archive)
State New, archived
Headers show
Series Clarify some of the fixup! documenation | expand

Commit Message

Philip Oakley May 25, 2020, 9:36 p.m. UTC
Ellipsis marks fail to hint at the typoe or style of the missing content.

Tell the reader what is missing, for easier comprehension.

Signed-off-by: Philip Oakley <philipoakley@iee.email>
---

The fixup/squash process could probably benefit from its own section
as there are many places for user interaction with the process.
This is a minimal shift toward such an improvement.
---
 Documentation/git-rebase.txt | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
diff mbox series

Patch

diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index dfd3d6d0ef..1d8237bfc6 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -534,15 +534,15 @@  See also INCOMPATIBLE OPTIONS below.
 
 --autosquash::
 --no-autosquash::
-	When the commit log message begins with "squash! ..." (or
-	"fixup! ..."), and there is already a commit in the todo list that
-	matches the same `...`, automatically modify the todo list of rebase
+	When the commit log message begins with "squash! <line>" (or
+	"fixup! <line>"), and there is already a commit in the todo list that
+	matches the same `<line>`, 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
+A commit matches the `<line>` if
+the commit subject matches, or if the `<line>` 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].