Skip to content

Commit

Permalink
docs: update immutable_heads() examples to use `builtin_immutable_h…
Browse files Browse the repository at this point in the history
…eads()`

Users should generally use `builtin_immutable_heads()` when they
override `immutable_heads()`, so this patch updates the existing
example to use that. I also added another example showing how to
make an additional remote-tracking bookmark immutable.
  • Loading branch information
martinvonz committed Oct 16, 2024
1 parent 4c25f34 commit 9e80d0c
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,13 +266,20 @@ diff-invocation-mode = "file-by-file"

You can configure the set of immutable commits via
`revset-aliases."immutable_heads()"`. The default set of immutable heads is
`builtin_immutable_heads()`, which in turn is defined as
`present(trunk()) | tags() | untracked_remote_bookmarks()`. For example, to
prevent rewriting commits on `main@origin` and commits authored by other users:
also consider the `maint@origin` bookmark immutable:

```toml
# The `main.. &` bit is an optimization to scan for non-`mine()` commits only
# among commits that are not in `main`.
revset-aliases."immutable_heads()" = "main@origin | (main@origin.. & ~mine())"
revset-aliases."immutable_heads()" = "builtin_immutable_heads() | maint@origin"
```

To prevent rewriting commits authored by other users:

```toml
# The `trunk().. &` bit is an optimization to scan for non-`mine()` commits
# only among commits that are not in `trunk()`.
revset-aliases."immutable_heads()" = "builtin_immutable_heads() | (trunk().. & ~mine())"
```

Ancestors of the configured set are also immutable. The root commit is always
Expand Down

0 comments on commit 9e80d0c

Please sign in to comment.