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

README: rewrite sections about the working-copy commit and repo-first design

Browse source 
I tried to clarify the benefits of these two features (#1708).
This commit is contained in:
Martin von Zweigbergk 2023-06-20 02:31:27 -07:00 committed by Martin von Zweigbergk
parent dc98a56119
commit 033b287e54
1 changed files with 16 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -63,19 +63,26 @@ add functionality that cannot easily be added to the Git backend.
### The working copy is automatically committed
Most Jujutsu commands automatically commit the working copy. This leads to a
simpler and more powerful interface, since all commands work the same way on the
working copy or any other commit. It also means that you can always check out a
different commit without first explicitly committing the working copy changes
(you can even check out a different commit while resolving merge conflicts).
Almost all Jujutsu commands automatically commit the working copy. That means
that commands never fail because the working copy is dirty (no "error: Your
local changes to the following files..."), and there is no need for `git stash`.
You also get an automatic backup of the working copy whenever you run a command.
Also, because the working copy is a commit, commands work the same way on the
working-copy commit as on any other commit, so you can set the commit message
before you're done with the changes.
<img src="demos/working_copy.png" />
### Operations update the repo first, then possibly the working copy
### The repo is the source of truth
The working copy is only updated at the end of an operation, after all other
changes have already been recorded. This means that you can run any command
(such as `jj rebase`) even if the working copy is dirty.
With Jujutsu, the working copy plays a smaller role than with Git. Commands
snapshot the working copy before they start, then the update the repo, and then
the working copy is updated (if the working-copy commit was modified). Almost
all commands (even checkout!) operate on the commits in the repo, leaving the
common functionality of snapshotting and updating of the working copy to
centralized code. For example, `jj restore` (similar to `git restore`) can
restore from any commit and into any commit, and `jj describe` can set the
commit message of any commit (defaults to the working-copy commit).
### Entire repo is under version control