diff mbox series

replay: Fix documentation of the --contained flag

Message ID 20240226-fix-replay-docs-v1-1-a5f8bf08414a@gmail.com (mailing list archive)
State New, archived
Headers show
Series replay: Fix documentation of the --contained flag | expand

Commit Message

Gabriel de Perthuis Feb. 26, 2024, 11:32 a.m. UTC 
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(-)


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

Best regards,
diff mbox series

Patch

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