mirror of
https://github.com/git-for-windows/git.git
synced 2026-04-09 23:33:34 -05:00
replay: use stuck form in documentation and help message
gitcli(7) suggests to use stuck form. Change the documentation strings to use this form. While at it, reorder them to match the order in the docs. Signed-off-by: Toon Claes <toon@iotcl.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
committed by
Junio C Hamano
parent
e5ae639f1a
commit
6542cacbb3
@@ -9,7 +9,8 @@ git-replay - EXPERIMENTAL: Replay commits on a new base, works with bare repos t
|
||||
SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
(EXPERIMENTAL!) 'git replay' ([--contained] --onto <newbase> | --advance <branch> | --revert <branch>) [--ref-action[=<mode>]] <revision-range>
|
||||
(EXPERIMENTAL!) 'git replay' ([--contained] --onto=<newbase> | --advance=<branch> | --revert=<branch>)
|
||||
[--ref-action=<mode>] <revision-range>
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
@@ -26,7 +27,7 @@ THIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE.
|
||||
OPTIONS
|
||||
-------
|
||||
|
||||
--onto <newbase>::
|
||||
--onto=<newbase>::
|
||||
Starting point at which to create the new commits. May be any
|
||||
valid commit, and not just an existing branch name.
|
||||
+
|
||||
@@ -34,7 +35,7 @@ When `--onto` is specified, the branch(es) in the revision range will be
|
||||
updated to point at the new commits, similar to the way `git rebase --update-refs`
|
||||
updates multiple branches in the affected range.
|
||||
|
||||
--advance <branch>::
|
||||
--advance=<branch>::
|
||||
Starting point at which to create the new commits; must be a
|
||||
branch name.
|
||||
+
|
||||
@@ -42,7 +43,7 @@ The history is replayed on top of the <branch> and <branch> is updated to
|
||||
point at the tip of the resulting history. This is different from `--onto`,
|
||||
which uses the target only as a starting point without updating it.
|
||||
|
||||
--revert <branch>::
|
||||
--revert=<branch>::
|
||||
Starting point at which to create the reverted commits; must be a
|
||||
branch name.
|
||||
+
|
||||
@@ -79,8 +80,8 @@ The default mode can be configured via the `replay.refAction` configuration vari
|
||||
|
||||
<revision-range>::
|
||||
Range of commits to replay; see "Specifying Ranges" in
|
||||
linkgit:git-rev-parse[1]. In `--advance <branch>` or
|
||||
`--revert <branch>` mode, the range should have a single tip,
|
||||
linkgit:git-rev-parse[1]. In `--advance=<branch>` or
|
||||
`--revert=<branch>` mode, the range should have a single tip,
|
||||
so that it's clear to which tip the advanced or reverted
|
||||
<branch> should point. Any commits in the range whose changes
|
||||
are already present in the branch the commits are being
|
||||
@@ -127,7 +128,7 @@ EXAMPLES
|
||||
To simply rebase `mybranch` onto `target`:
|
||||
|
||||
------------
|
||||
$ git replay --onto target origin/main..mybranch
|
||||
$ git replay --onto=target origin/main..mybranch
|
||||
------------
|
||||
|
||||
The refs are updated atomically and no output is produced on success.
|
||||
@@ -135,14 +136,14 @@ The refs are updated atomically and no output is produced on success.
|
||||
To see what would be updated without actually updating:
|
||||
|
||||
------------
|
||||
$ git replay --ref-action=print --onto target origin/main..mybranch
|
||||
$ git replay --ref-action=print --onto=target origin/main..mybranch
|
||||
update refs/heads/mybranch ${NEW_mybranch_HASH} ${OLD_mybranch_HASH}
|
||||
------------
|
||||
|
||||
To cherry-pick the commits from mybranch onto target:
|
||||
|
||||
------------
|
||||
$ git replay --advance target origin/main..mybranch
|
||||
$ git replay --advance=target origin/main..mybranch
|
||||
------------
|
||||
|
||||
Note that the first two examples replay the exact same commits and on
|
||||
@@ -154,7 +155,7 @@ What if you have a stack of branches, one depending upon another, and
|
||||
you'd really like to rebase the whole set?
|
||||
|
||||
------------
|
||||
$ git replay --contained --onto origin/main origin/main..tipbranch
|
||||
$ git replay --contained --onto=origin/main origin/main..tipbranch
|
||||
------------
|
||||
|
||||
All three branches (`branch1`, `branch2`, and `tipbranch`) are updated
|
||||
@@ -165,7 +166,7 @@ commits to replay using the syntax `A..B`; any range expression will
|
||||
do:
|
||||
|
||||
------------
|
||||
$ git replay --onto origin/main ^base branch1 branch2 branch3
|
||||
$ git replay --onto=origin/main ^base branch1 branch2 branch3
|
||||
------------
|
||||
|
||||
This will simultaneously rebase `branch1`, `branch2`, and `branch3`,
|
||||
@@ -176,7 +177,7 @@ that they have in common, but that does not need to be the case.
|
||||
To revert commits on a branch:
|
||||
|
||||
------------
|
||||
$ git replay --revert main topic~2..topic
|
||||
$ git replay --revert=main topic~2..topic
|
||||
------------
|
||||
|
||||
This reverts the last two commits from `topic`, creating revert commits on
|
||||
|
||||
@@ -84,8 +84,8 @@ int cmd_replay(int argc,
|
||||
|
||||
const char *const replay_usage[] = {
|
||||
N_("(EXPERIMENTAL!) git replay "
|
||||
"([--contained] --onto <newbase> | --advance <branch> | --revert <branch>) "
|
||||
"[--ref-action[=<mode>]] <revision-range>"),
|
||||
"([--contained] --onto=<newbase> | --advance=<branch> | --revert=<branch>)\n"
|
||||
"[--ref-action=<mode>] <revision-range>"),
|
||||
NULL
|
||||
};
|
||||
struct option replay_options[] = {
|
||||
|
||||
Reference in New Issue
Block a user