Merge branch 'en/replay-doc-revision-range'

The use of "revision" (a connected set of commits) has been
clarified in the "git replay" documentation.

* en/replay-doc-revision-range:
  Documentation/git-replay.adoc: fix errors around revision range
This commit is contained in:
Junio C Hamano
2025-12-09 07:54:56 +09:00
2 changed files with 7 additions and 8 deletions

View File

@@ -9,12 +9,12 @@ git-replay - EXPERIMENTAL: Replay commits on a new base, works with bare repos t
SYNOPSIS SYNOPSIS
-------- --------
[verse] [verse]
(EXPERIMENTAL!) 'git replay' ([--contained] --onto <newbase> | --advance <branch>) [--ref-action[=<mode>]] <revision-range>... (EXPERIMENTAL!) 'git replay' ([--contained] --onto <newbase> | --advance <branch>) [--ref-action[=<mode>]] <revision-range>
DESCRIPTION DESCRIPTION
----------- -----------
Takes ranges of commits and replays them onto a new location. Leaves Takes a range of commits and replays them onto a new location. Leaves
the working tree and the index untouched. By default, updates the the working tree and the index untouched. By default, updates the
relevant references using an atomic transaction (all refs update or relevant references using an atomic transaction (all refs update or
none). Use `--ref-action=print` to avoid automatic ref updates and none). Use `--ref-action=print` to avoid automatic ref updates and
@@ -55,11 +55,10 @@ which uses the target only as a starting point without updating it.
The default mode can be configured via the `replay.refAction` configuration variable. The default mode can be configured via the `replay.refAction` configuration variable.
<revision-range>:: <revision-range>::
Range of commits to replay. More than one <revision-range> can Range of commits to replay; see "Specifying Ranges" in
be passed, but in `--advance <branch>` mode, they should have linkgit:git-rev-parse[1]. In `--advance <branch>` mode, the
a single tip, so that it's clear where <branch> should point range should have a single tip, so that it's clear to which tip the
to. See "Specifying Ranges" in linkgit:git-rev-parse[1] and the advanced <branch> should point.
"Commit Limiting" options below.
include::rev-list-options.adoc[] include::rev-list-options.adoc[]

View File

@@ -366,7 +366,7 @@ int cmd_replay(int argc,
const char *const replay_usage[] = { const char *const replay_usage[] = {
N_("(EXPERIMENTAL!) git replay " N_("(EXPERIMENTAL!) git replay "
"([--contained] --onto <newbase> | --advance <branch>) " "([--contained] --onto <newbase> | --advance <branch>) "
"[--ref-action[=<mode>]] <revision-range>..."), "[--ref-action[=<mode>]] <revision-range>"),
NULL NULL
}; };
struct option replay_options[] = { struct option replay_options[] = {