mirrors/jj
1
0
Fork 1
mirror of https://github.com/martinvonz/jj.git synced 2024-11-25 00:36:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8
jj/docs/working-copy.md

87 lines
4.1 KiB
Markdown
Raw Normal View History

docs: replace `jj concepts` by markdown docs I wanted to have all the documentation available on the command line, but that makes it harder to maintain and link to. Let's move it to markdown instead. We may later be able to add some way of presenting the markdown in the terminal (or maybe by first converting it to reStructuredText).
2021-12-17 21:28:09 +00:00
# Working copy
## Introduction
docs: change "current checkout" to "working-copy commit" I think "the working-copy commit" is clearer.
2022-09-18 21:46:12 +00:00
The working copy is where the current working-copy commit's files are written so
you can interact with them. It also where files are read from in order to create
new commits (though there are many other ways of creating new commits).
docs: replace `jj concepts` by markdown docs I wanted to have all the documentation available on the command line, but that makes it harder to maintain and link to. Let's move it to markdown instead. We may later be able to add some way of presenting the markdown in the terminal (or maybe by first converting it to reStructuredText).
2021-12-17 21:28:09 +00:00
Unlike most other VCSs, Jujutsu will automatically create commits from the
docs: hyphenate "working-copy" when used as a compound modifier
2022-08-25 23:34:18 +00:00
working-copy contents when they have changed. Most `jj` commands you run will
commit the working-copy changes if they have changed. The resulting revision
will replace the previous working-copy revision.
docs: replace `jj concepts` by markdown docs I wanted to have all the documentation available on the command line, but that makes it harder to maintain and link to. Let's move it to markdown instead. We may later be able to add some way of presenting the markdown in the terminal (or maybe by first converting it to reStructuredText).
2021-12-17 21:28:09 +00:00
Also unlike most other VCSs, added files are implicitly tracked. That means that
if you add a new file to the working copy, it will be automatically committed
once you run e.g. `jj st`. Similarly, if you remove a file from the working
docs: explain how to untrack a file while keeping it in the working copy Issue #14 was fixed a while ago, but I forgot to update the documentation.
2021-12-17 23:18:41 +00:00
copy, it will implicitly be untracked. To untrack a file while keeping it in
the working copy, first make sure it's [ignored](#ignored-files) and then run
`jj untrack <path>`.
docs: replace `jj concepts` by markdown docs I wanted to have all the documentation available on the command line, but that makes it harder to maintain and link to. Let's move it to markdown instead. We may later be able to add some way of presenting the markdown in the terminal (or maybe by first converting it to reStructuredText).
2021-12-17 21:28:09 +00:00
## Conflicts
docs: update doc about working copy now that conflicts are preserved Conflicts are preserved in the working copy since ea823406541e, I just forgot to update the documentation.
2021-12-17 23:59:56 +00:00
When you check out a commit with conflicts, those conflicts need to be
represented in the working copy somehow. However, the file system doesn't
understand conflicts. Jujutsu's solution is to add conflict markers to
conflicted files when it writes them to the working copy. It also keeps track of
the (typically 3) different parts involved in the conflict. Whenever it scans
the working copy thereafter, it parses the conflict markers and recreates the
conflict state from them. You can resolve conflicts by replacing the conflict
markers by the resolved text. You don't need to resolve all conflicts at once.
You can even resolve part of a conflict by updating the different parts of the
conflict marker.
docs: describe the conflict-resolution workflow without open commits
2022-11-05 01:02:35 +00:00
To resolve conflicts in a commit, use `jj new <commit>` to create a working-copy
commit on top. You would then have the same conflicts in the working-copy
commit. Once you have resolved the conflicts, you can inspect the conflict
resolutions with `jj diff`. Then run `jj squash` to move the conflict
resolutions into the conflicted commit. Alternatively, you can edit the commit
with conflicts directly in the working copy by using `jj edit <commit>`. The
main disadvantage of that is that it's harder to inspect the conflict
resolutions.
docs: replace `jj concepts` by markdown docs I wanted to have all the documentation available on the command line, but that makes it harder to maintain and link to. Let's move it to markdown instead. We may later be able to add some way of presenting the markdown in the terminal (or maybe by first converting it to reStructuredText).
2021-12-17 21:28:09 +00:00
`docs/working-copy.md`: Mention `jj resolve`
2023-01-13 06:58:03 +00:00
With the `jj resolve` command, you can use an external merge tool to resolve
conflicts that have 2 sides and a base. There is not yet a good way of
docs: replace `jj concepts` by markdown docs I wanted to have all the documentation available on the command line, but that makes it harder to maintain and link to. Let's move it to markdown instead. We may later be able to add some way of presenting the markdown in the terminal (or maybe by first converting it to reStructuredText).
2021-12-17 21:28:09 +00:00
resolving conflicts between directories, files, and symlinks
`docs/working-copy.md`: Mention `jj resolve`
2023-01-13 06:58:03 +00:00
(https://github.com/martinvonz/jj/issues/19). You can use `jj restore` to choose
one side of the conflict, but there's no way to even see where the involved
parts came from.
docs: replace `jj concepts` by markdown docs I wanted to have all the documentation available on the command line, but that makes it harder to maintain and link to. Let's move it to markdown instead. We may later be able to add some way of presenting the markdown in the terminal (or maybe by first converting it to reStructuredText).
2021-12-17 21:28:09 +00:00
## Ignored files
You probably don't want build outputs and temporary files to be under version
control. You can tell Jujutsu to not automatically track certain files by using
`.gitignore` files (there's no such thing as `.jjignore` yet).
See https://git-scm.com/docs/gitignore for details about the format.
`.gitignore` files are supported in any directory in the working copy, as well
as in `$HOME/.gitignore`. However, `$GIT_DIR/info/exclude` or equivalent way
(maybe `.jj/gitignore`) of specifying per-clone ignores is not yet supported.
docs: describe how to use multiple workspaces We have had support for workspaces for six months, but I forgot to update the documentation. This just adds some basic documentation; we can add more later.
2022-08-26 00:23:04 +00:00
## Workspaces
You can have multiple working copies backed by a single repo. Use
`jj workspace add` to create a new working copy. The working copy will have a
`.jj/` directory linked to the main repo. The working copy and the `.jj/`
directory together is called a "workspace". Each workspace can have a different
commit checked out.
Having multiple workspaces can be useful for running long-running tests in a one
workspace: add a root subcommand to print the workspace root path
2023-01-24 11:46:59 +00:00
while you continue developing in another, for example. If needed,
`jj workspace root` prints the root path of the current workspace.
docs: describe how to use multiple workspaces We have had support for workspaces for six months, but I forgot to update the documentation. This just adds some basic documentation; we can add more later.
2022-08-26 00:23:04 +00:00
When you're done using a workspace, use `jj workspace forget` to make the repo
forget about it. The files can be deleted from disk separately (either before or
after).
cli: add a command for updating a stale working copy When a workspace's working-copy commit is updated from another workspace, the workspace becomes "stale". That means that the working copy on disk doesn't represent the commit that the repo's view says it should. In this state, we currently automatically it to the desired commit next time the user runs any command in the workspace. That can be undesirable e.g. if the user had a slow build or test run started in the working copy. It can also be surprising that a checkout happens when the user ran a seemingly readonly command like `jj status`. This patch makes most commands instead error out if the working copy is stale, and adds a `jj workspace update-stale` to update it. The user can still run commands with `--no-commit-working-copy` in this state (doing e.g. `jj --no-commit-working-copy rebase -r @ -d @--` is another way of getting into the stale-working-copy state, by the way).
2022-10-02 17:09:46 +00:00
### Stale working copy
When you modify workspace A's working-copy commit from workspace B, workspace
A's working copy will become stale. By "stale", we mean that the files in the
working copy don't match the desired commit indicated by the `@` symbol in
`jj log`. When that happens, use `jj workspace update-stale` to update the files
in the working copy.
Reference in a new issue Copy permalink