[PATCH v2] doc: document rev-list opts in revert, cherry-pick
- From
Emily Shaffer via GitGitGadget <gitgitgadget@gmail.com>
- Date
- Aug 27, 2025, 07:22 UTC
- Message-ID
- <pull.2042.v2.git.git.1756279345929.gitgitgadget@gmail.com>
- In-Reply-To
- <pull.2042.git.git.1756279041881.gitgitgadget@gmail.com>
From: Emily Shaffer <emilyshaffer@google.com>
In f873a273d1 (revert: accept arbitrary rev-list options, 2010-06-14), we added a handful of new options to `git revert` and `git cherry-pick`, but did not document them except by example to `cherry-pick` only. We have a nice shorthand for adding the rev-list documentation, so let's add it now, to both commands.
Reported-by: Andrew Jeffrey <andrew@aj.id.au>
Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
---
cherry-pick: document rev-list options
Ach, sorry for the noise, turns out it touched both revert and
cherry-pick, might as well do the docs for both.Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-2042%2Fnasamuffin%2Fcherry-pick-docs-v2 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-2042/nasamuffin/cherry-pick-docs-v2 Pull-Request: https://github.com/git/git/pull/2042
Range-diff vs v1:
1: fa352ccda08 ! 1: f41cb4e8abc cherry-pick: document rev-list options
@@ Metadata
Author: Emily Shaffer <emilyshaffer@google.com>
## Commit message ##
- cherry-pick: document rev-list options
+ doc: document rev-list opts in revert, cherry-pick
In f873a273d1 (revert: accept arbitrary rev-list options, 2010-06-14),
- we added a handful of new options to `git cherry-pick`, but did not
- document them except by example. We have a nice shorthand for adding the
- rev-list documentation, so let's add it now.
+ we added a handful of new options to `git revert` and `git cherry-pick`,
+ but did not document them except by example to `cherry-pick` only. We
+ have a nice shorthand for adding the rev-list documentation, so let's
+ add it now, to both commands.
Reported-by: Andrew Jeffrey <andrew@aj.id.au>
Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
@@ Documentation/git-cherry-pick.adoc: fail unless one of `--empty=keep` or `--allo
SEQUENCER SUBCOMMANDS
---------------------
include::sequencer.adoc[]
+
+ ## Documentation/git-revert.adoc ##
+@@ Documentation/git-revert.adoc: include::rerere-options.adoc[]
+ configuration variable can be used to enable this option by
+ default.
+
++include::rev-list-options.adoc[]
+
+ SEQUENCER SUBCOMMANDS
+ ---------------------Documentation/git-cherry-pick.adoc | 2 ++ Documentation/git-revert.adoc | 1 + 2 files changed, 3 insertions(+)
diff --git a/Documentation/git-cherry-pick.adoc b/Documentation/git-cherry-pick.adoc index 42b41923d5f..03848aa9f21 100644 --- a/Documentation/git-cherry-pick.adoc +++ b/Documentation/git-cherry-pick.adoc @@ -174,6 +174,8 @@ fail unless one of `--empty=keep` or `--allow-empty` are specified. include::rerere-options.adoc[] +include::rev-list-options.adoc[] + SEQUENCER SUBCOMMANDS --------------------- include::sequencer.adoc[] diff --git a/Documentation/git-revert.adoc b/Documentation/git-revert.adoc index ffba365e639..28827807473 100644 --- a/Documentation/git-revert.adoc +++ b/Documentation/git-revert.adoc @@ -122,6 +122,7 @@ include::rerere-options.adoc[] configuration variable can be used to enable this option by default. +include::rev-list-options.adoc[] SEQUENCER SUBCOMMANDS --------------------- base-commit: f814da676ae46aac5be0a98b99373a76dee6cedb
-- gitgitgadget