[PATCH 2/3] doc: document history signing options
- From
- Souma <git@5ouma.me>
- Date
- Jul 3, 2026, 14:50 UTC
- Message-ID
- <20260703145037.69832-3-git@5ouma.me>
- In-Reply-To
- <20260703145037.69832-1-git@5ouma.me>
The history manual and usage text should describe the signing controls now accepted by fixup, reword, and split.
Document -S/--gpg-sign and --no-gpg-sign with the same key-id spelling and configuration override behavior used by commit-style signing options.
Signed-off-by: Souma <git@5ouma.me> --- Documentation/git-history.adoc | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-history.adoc b/Documentation/git-history.adoc index 2ba8121795..a1dd5c8580 100644 --- a/Documentation/git-history.adoc +++ b/Documentation/git-history.adoc @@ -8,9 +8,9 @@ git-history - EXPERIMENTAL: Rewrite history SYNOPSIS -------- [synopsis] -git history fixup <commit> [--dry-run] [--update-refs=(branches|head)] [--reedit-message] [--empty=(drop|keep|abort)] -git history reword <commit> [--dry-run] [--update-refs=(branches|head)] -git history split <commit> [--dry-run] [--update-refs=(branches|head)] [--] [<pathspec>...] +git history fixup <commit> [--dry-run] [--update-refs=(branches|head)] [--reedit-message] [--empty=(drop|keep|abort)] [--[no-]gpg-sign[=<key-id>]] +git history reword <commit> [--dry-run] [--update-refs=(branches|head)] [--[no-]gpg-sign[=<key-id>]] +git history split <commit> [--dry-run] [--update-refs=(branches|head)] [--[no-]gpg-sign[=<key-id>]] [--] [<pathspec>...] DESCRIPTION ----------- @@ -109,6 +109,14 @@ OPTIONS `--reedit-message`:: Open an editor to modify the target commit's message. +`-S[<key-id>]`:: +`--gpg-sign[=<key-id>]`:: +`--no-gpg-sign`:: + GPG-sign rewritten commits. The _<key-id>_ argument is optional and + defaults to the committer identity; if specified, it must be stuck to + the option without a space. `--no-gpg-sign` is useful to countermand + both `commit.gpgSign` configuration and earlier `--gpg-sign`. + `--empty=(drop|keep|abort)`:: Control what happens when a commit becomes empty as a result of the fixup. This can happen in two situations:
-- 2.55.0