ok/jj
1
0
Fork 0
forked from mirrors/jj
Code Pull requests Activity

docs/tutorial.md: introduce both long and short names of each option

Browse source
This commit is contained in:
Gabriel Scherer 2023-10-23 06:51:04 +02:00
parent aacad9dc8c
commit 8ade4d083a
1 changed files with 15 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
docs/tutorial.md
View file

@ -134,13 +134,13 @@ IDs because they stay the same when the commit is rewritten.
By default, `jj log` lists your local commits, with some remote commits added By default, `jj log` lists your local commits, with some remote commits added
for context. The `~` indicates that the commit has parents that are not for context. The `~` indicates that the commit has parents that are not
included in the graph. We can use the `-r` flag to select a different set of included in the graph. We can use the `--revisions`/`-r` flag to select a
revisions to list. The flag accepts a ["revset"](revsets.md), which is an different set of revisions to list. The flag accepts a ["revset"](revsets.md),
expression in a simple language for specifying revisions. For example, `@` which is an expression in a simple language for specifying revisions. For
refers to the working-copy commit, `root()` refers to the root commit, example, `@` refers to the working-copy commit, `root()` refers to the root
`branches()` refers to all commits pointed to by branches. We can combine commit, `branches()` refers to all commits pointed to by branches. We can
expressions with `|` for union, `&` for intersection and `~` for difference. For combine expressions with `|` for union, `&` for intersection and `~` for
example: difference. For example:
```shell ```shell
$ jj log -r '@ | root() | branches()' $ jj log -r '@ | root() | branches()'
@ mpqrykypylvy martinvonz@google.com 2023-02-12 15:00:22.000 -08:00 aef4df99ea11 @ mpqrykypylvy martinvonz@google.com 2023-02-12 15:00:22.000 -08:00 aef4df99ea11
@ -168,7 +168,9 @@ input set if they're ancestors of other revisions in the set.
## Conflicts ## Conflicts
Now let's see how Jujutsu deals with merge conflicts. We'll start by making some Now let's see how Jujutsu deals with merge conflicts. We'll start by making some
commits: commits. We use `jj new` with the `--message`/`-m` option to set change
descriptions (commit messages) right away.
```shell ```shell
# Start creating a chain of commits off of the `master` branch # Start creating a chain of commits off of the `master` branch
$ jj new master -m A; echo a > file1 $ jj new master -m A; echo a > file1
@ -197,7 +199,10 @@ $ jj log
``` ```
We now have a few commits, where A, B1, and B2 modify the same file, while C We now have a few commits, where A, B1, and B2 modify the same file, while C
modifies a different file. Let's now rebase B2 directly onto A: modifies a different file. Let's now rebase B2 directly onto A. We use the
`--source`/`-s` option on the change ID of B2, and `--destination`/`-d` option
on A.
```shell ```shell
$ jj rebase -s puqltuttrvzp -d nuvyytnqlquo $ jj rebase -s puqltuttrvzp -d nuvyytnqlquo
Rebased 2 commits Rebased 2 commits
@ -361,7 +366,7 @@ $ jj log -r master::@
We "forgot" to capitalize "c" in the second commit when we capitalized the other We "forgot" to capitalize "c" in the second commit when we capitalized the other
letters. We then fixed that in the third commit when we also added "D". It would letters. We then fixed that in the third commit when we also added "D". It would
be cleaner to move the capitalization of "c" into the second commit. We can do be cleaner to move the capitalization of "c" into the second commit. We can do
that by running `jj squash -i` (short for `jj squash --interactive`) on the that by running `jj squash` with the `--interactive`/`-i` option on the
third commit. Remember that `jj squash` moves all the changes from one commit third commit. Remember that `jj squash` moves all the changes from one commit
into its parent. `jj squash -i` moves only part of the changes into its parent. into its parent. `jj squash -i` moves only part of the changes into its parent.
Now try that: Now try that: