Skip to content

Commit

Permalink
docs: revert to using revset operator : instead of ::
Browse files Browse the repository at this point in the history
Since our latest release doesn't support `::`, we shouldn't tell the
user to use it.

This commit should be backed out we've released jj 0.9.0.
  • Loading branch information
martinvonz committed Aug 1, 2023
1 parent 48b1a1c commit 21b6978
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 18 deletions.
4 changes: 2 additions & 2 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ To get shorter prefixes for certain revisions, set `revsets.short-prefixes`:

```toml
# Prioritize the current branch
revsets.short-prefixes = "(main..@)::"
revsets.short-prefixes = "(main..@):"
```

### Relative timestamps
Expand Down Expand Up @@ -259,7 +259,7 @@ You can define aliases for commands, including their arguments. For example:
```toml
# `jj l` shows commits on the working-copy commit's (anonymous) branch
# compared to the `main` branch
aliases.l = ["log", "-r", "(main..@):: | (main..@)-"]
aliases.l = ["log", "-r", "(main..@): | (main..@)-"]
```

## Editor
Expand Down
2 changes: 1 addition & 1 deletion docs/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ remote
Log all remote branches, which you authored or committed to
`jj log -r 'remote_branches() & (committer([email protected]) | author([email protected]))'`
Log all descendants of the current working copy, which aren't on a remote
`jj log -r '::@ & ~remote_branches()'`
`jj log -r ':@ & ~remote_branches()'`

## Merge conflicts

Expand Down
26 changes: 13 additions & 13 deletions docs/revsets.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,16 +58,16 @@ only symbols.
* `~x`: Revisions that are not in `x`.
* `x-`: Parents of `x`.
* `x+`: Children of `x`.
* `::x`: Ancestors of `x`, including the commits in `x` itself.
* `x::`: Descendants of `x`, including the commits in `x` itself.
* `x::y`: Descendants of `x` that are also ancestors of `y`. Equivalent
to `x:: & ::y`. This is what `git log` calls `--ancestry-path x..y`.
* `:x`, `x:`, and `x:y`: Deprecated synonyms for `::x`, `x::`, and `x::y`. We
plan to delete them in jj 0.15+.
* `:x`: Ancestors of `x`, including the commits in `x` itself.
* `x:`: Descendants of `x`, including the commits in `x` itself.
* `x:y`: Descendants of `x` that are also ancestors of `y`. Equivalent
to `x: & :y`. This is what `git log` calls `--ancestry-path x..y`.
* `::x`, `x::`, and `x::y`: New versions of for `:x`, `x:`, and `x:y` to be
released in jj 0.9.0. We plan to delete the latter in jj 0.15+.
* `x..y`: Ancestors of `y` that are not also ancestors of `x`. Equivalent to
`::y ~ ::x`. This is what `git log` calls `x..y` (i.e. the same as we call it).
`:y ~ :x`. This is what `git log` calls `x..y` (i.e. the same as we call it).
* `..x`: Ancestors of `x`, including the commits in `x` itself. Equivalent to
`::x` and provided for consistency.
`:x` and provided for consistency.
* `x..`: Revisions that are not ancestors of `x`.

You can use parentheses to control evaluation order, such as `(x & y) | z` or
Expand All @@ -80,9 +80,9 @@ revsets (expressions) as arguments.

* `parents(x)`: Same as `x-`.
* `children(x)`: Same as `x+`.
* `ancestors(x)`: Same as `::x`.
* `descendants(x)`: Same as `x::`.
* `connected(x)`: Same as `x::x`. Useful when `x` includes several commits.
* `ancestors(x)`: Same as `:x`.
* `descendants(x)`: Same as `x:`.
* `connected(x)`: Same as `x:x`. Useful when `x` includes several commits.
* `all()`: All visible commits in the repo.
* `none()`: No commits. This function is rarely useful; it is provided for
completeness.
Expand Down Expand Up @@ -171,7 +171,7 @@ jj log -r 'remote_branches(remote=origin)..'
Show all ancestors of the working copy (almost like plain `git log`)

```
jj log -r ::@
jj log -r :@
```

Show the initial commits in the repo (the ones Git calls "root commits"):
Expand All @@ -191,7 +191,7 @@ those commits:


```
jj log -r '(remote_branches()..@)::'
jj log -r '(remote_branches()..@):'
```

Show commits authored by "martinvonz" and containing the word "reset" in the
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ called the "root commit". It's the root commit of every repo. The `root` symbol
in the revset matches it.
There are also operators for getting the parents (`foo-`), children (`foo+`),
ancestors (`::foo`), descendants (`foo::`), DAG range (`foo::bar`, like
ancestors (`:foo`), descendants (`foo:`), DAG range (`foo:bar`, like
`git log --ancestry-path`), range (`foo..bar`, same as Git's). There are also a
few more functions, such as `heads(<set>)`, which filters out revisions in the
input set if they're ancestors of other revisions in the set.
Expand Down Expand Up @@ -345,7 +345,7 @@ $ jj new -m ABC; printf 'A\nB\nc\n' > file
Working copy now at: 6f30cd1fb351 ABC
$ jj new -m ABCD; printf 'A\nB\nC\nD\n' > file
Working copy now at: a67491542e10 ABCD
$ jj log -r master::@
$ jj log -r master:@
@ mrxqplykzpkw [email protected] 2023-02-12 19:38:21.000 -08:00 b98c607bf87f
│ ABCD
◉ kwtuwqnmqyqp [email protected] 2023-02-12 19:38:12.000 -08:00 30aecc0871ea
Expand Down

0 comments on commit 21b6978

Please sign in to comment.