cybercyst/jj
1
0
Fork 0
mirror of https://github.com/martinvonz/jj.git synced 2025-05-05 15:32:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add diagrams for jj new --after and --before

Browse Source
This commit is contained in:
Emily 2025-02-10 02:03:45 +01:00
parent 6dbc1eba42
commit 8c506006b2
2 changed files with 108 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
cli/src/commands/new.rs
View File

@ -65,22 +65,77 @@ pub(crate) struct NewArgs {
#[arg(long, hide = true)]
_edit: bool,
/// Insert the new change after the given commit(s)
///
/// Example: `jj new --after A` creates a new change between `A` and its
/// children:
///
/// ```text
/// B C
/// \ /
/// B C => @
/// \ / |
/// A A
/// ```
///
/// Specifying `--after` multiple times will relocate all children of the
/// given commits.
///
/// Example: `jj new --after A --after X` creates a change with `A` and `X`
/// as parents, and rebases all children on top of the new change:
///
/// ```text
/// B Y
/// \ /
/// B Y => @
/// | | / \
/// A X A X
/// ```
#[arg(
long,
short = 'A',
visible_alias = "after",
conflicts_with = "revisions",
value_name = "REVSETS",
verbatim_doc_comment,
add = ArgValueCandidates::new(complete::all_revisions),
)]
insert_after: Option<Vec<RevisionArg>>,
/// Insert the new change before the given commit(s)
///
/// Example: `jj new --before C` creates a new change between `C` and its
/// parents:
///
/// ```text
/// C
/// |
/// C => @
/// / \ / \
/// A B A B
/// ```
///
/// `--after` and `--before` can be combined.
///
/// Example: `jj new --after A --before D`:
///
/// ```text
///
/// D D
/// | / \
/// C | C
/// | => @ |
/// B | B
/// | \ /
/// A A
/// ```
///
/// Similar to `--after`, you can specify `--before` multiple times.
#[arg(
long,
short = 'B',
visible_alias = "before",
conflicts_with = "revisions",
value_name = "REVSETS",
verbatim_doc_comment,
add = ArgValueCandidates::new(complete::mutable_revisions),
)]
insert_before: Option<Vec<RevisionArg>>,

53
cli/tests/cli-reference@.md.snap
View File

@ -1513,8 +1513,61 @@ Note that you can create a merge commit by specifying multiple revisions as argu
* `-m`, `--message <MESSAGE>` — The change description to use
* `--no-edit` — Do not edit the newly created change
* `-A`, `--insert-after <REVSETS>` — Insert the new change after the given commit(s)
Example: `jj new --after A` creates a new change between `A` and its
children:
```text
B C
\ /
B C => @
\ / |
A A
```
Specifying `--after` multiple times will relocate all children of the
given commits.
Example: `jj new --after A --after X` creates a change with `A` and `X`
as parents, and rebases all children on top of the new change:
```text
B Y
\ /
B Y => @
| | / \
A X A X
```
* `-B`, `--insert-before <REVSETS>` — Insert the new change before the given commit(s)
Example: `jj new --before C` creates a new change between `C` and its
parents:
```text
C
|
C => @
/ \ / \
A B A B
```
`--after` and `--before` can be combined.
Example: `jj new --after A --before D`:
```text
D D
| / \
C | C
| => @ |
B | B
| \ /
A A
```
Similar to `--after`, you can specify `--before` multiple times.
## `jj next`