git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Gabriel de Perthuis <g2p.code@gmail.com>
To: g2p.code@gmail.com, git@vger.kernel.org
Cc: Elijah Newren <newren@gmail.com>
Subject: [PATCH] replay: Fix documentation of the --contained flag
Date: Mon, 26 Feb 2024 12:32:15 +0100	[thread overview]
Message-ID: <20240226-fix-replay-docs-v1-1-a5f8bf08414a@gmail.com> (raw)

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


                 reply	other threads:[~2024-02-26 11:32 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=20240226-fix-replay-docs-v1-1-a5f8bf08414a@gmail.com \
    --to=g2p.code@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=newren@gmail.com \
    /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 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).