[PATCH 1/2] doc: fixup/squash: clarify use of <oid-hash> in subject line
- From
Philip Oakley <philipoakley@iee.email>
- Date
- May 25, 2020, 21:36 UTC
- Message-ID
- <20200525213632.1626-2-philipoakley@iee.email>
- 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