Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Rework bookmarks.md #4495

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: Rework bookmarks.md #4495

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions docs/bookmarks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,8 @@ pass a bookmark's name to commands that want a revision as argument. For example
`jj bookmark list` to list bookmarks and `jj bookmark` to create, move, or delete
bookmarks. There is currently no concept of an active/current/checked-out bookmark.

Currently Jujutsu maps its Bookmarks to Git Branches and stores them as that
in the Git backend. This means that all Bookmarks will be reflected as
Git Branches, this may change in the future.
In a Jujutsu repo that's colocated with Git, Jujutsu's bookmarks currently map
to Git branches, this may change in the future.

## Remotes and tracked bookmarks

Expand Down Expand Up @@ -61,7 +60,7 @@ If you want to know the internals of bookmark tracking, consult the
actual state only when it's actively communicating with the remote. However,
`jj` does store the last-seen position of the remote bookmark; this is the
commit `jj show <bookmark name>@<remote name>` would show. This notion is
completely analogous to Git's "remote-tracking bookmarks".
completely analogous to Git's "remote-tracking branches".
- A **tracked (remote) bookmark** is defined above. You can make a remote bookmark
tracked with the [`jj bookmark track` command](#manually-tracking-a-bookmark), for
example.
Expand Down Expand Up @@ -140,7 +139,7 @@ The default can be changed by setting the config `git.auto-local-bookmark = true
Then, `jj git fetch` tracks every *newly fetched* bookmark with a local bookmark.
Branches that already existed before the `jj git fetch` are not affected. This
is similar to Mercurial, which fetches all its bookmarks (equivalent to Git
bookmarks) by default.
branches) by default.

## Bookmark movement

Expand Down