From: "Emily Shaffer via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Andrew Jeffrey <andrew@aj.id.au>,
Emily Shaffer <emilyshaffer@google.com>,
Emily Shaffer <emilyshaffer@google.com>
Subject: [PATCH v2] doc: document rev-list opts in revert, cherry-pick
Date: Wed, 27 Aug 2025 07:22:25 +0000 [thread overview]
Message-ID: <pull.2042.v2.git.git.1756279345929.gitgitgadget@gmail.com> (raw)
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
next prev parent reply other threads:[~2025-08-27 7:22 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-08-27 7:17 [PATCH] cherry-pick: document rev-list options Emily Shaffer via GitGitGadget
2025-08-27 7:22 ` Emily Shaffer via GitGitGadget [this message]
2025-08-27 7:36 ` [PATCH v2] doc: document rev-list opts in revert, cherry-pick Andrew Jeffery
2025-08-27 9:41 ` Phillip Wood
2025-08-27 11:34 ` Emily Shaffer
2025-08-27 16:14 ` Junio C Hamano
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=pull.2042.v2.git.git.1756279345929.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=andrew@aj.id.au \
--cc=emilyshaffer@google.com \
--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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.