git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] replay: Fix documentation of the --contained flag
@ 2024-02-26 11:32 Gabriel de Perthuis
  0 siblings, 0 replies; only message in thread
From: Gabriel de Perthuis @ 2024-02-26 11:32 UTC (permalink / raw)
  To: g2p.code, git; +Cc: Elijah Newren

There was a paragraph describing the behaviour of that flag (which
affects branches and refs), but referring to it as --onto.
--contained is used with --onto but it is a more specific flag.
--onto by itself refers to a commit and does not have the described
effect on branches.

Signed-off-by: Gabriel de Perthuis <g2p.code@gmail.com>
---
 Documentation/git-replay.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-replay.txt b/Documentation/git-replay.txt
index f6c269c62d..ab28e86a4a 100644
--- a/Documentation/git-replay.txt
+++ b/Documentation/git-replay.txt
@@ -27,12 +27,12 @@ OPTIONS
 
 --onto <newbase>::
 	Starting point at which to create the new commits.  May be any
 	valid commit, and not just an existing branch name.
 +
-When `--onto` is specified, the update-ref command(s) in the output will
-update the branch(es) in the revision range to point at the new
+When `--contained` is specified, the update-ref command(s) in the output will
+update any branch(es) pointing within the revision range to point at the new
 commits, similar to the way how `git rebase --update-refs` updates
 multiple branches in the affected range.
 
 --advance <branch>::
 	Starting point at which to create the new commits; must be a

---
base-commit: 3c2a3fdc388747b9eaf4a4a4f2035c1c9ddb26d0
change-id: 20240226-fix-replay-docs-70a54ea9e3c8

Best regards,
-- 
Gabriel de Perthuis


^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2024-02-26 11:32 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-02-26 11:32 [PATCH] replay: Fix documentation of the --contained flag Gabriel de Perthuis

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).