From b6c65c12aca94c0574b629424931ea7f772babed Mon Sep 17 00:00:00 2001 From: Martin von Zweigbergk Date: Wed, 2 Aug 2023 09:05:24 -0700 Subject: [PATCH] readme: clarify that snapshotting doesn't result in a chain of commits It's not clear at all right now that snapshotting the working copy results in it being amended. --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7d3d66a6d..cbd129653 100644 --- a/README.md +++ b/README.md @@ -63,13 +63,16 @@ add functionality that cannot easily be added to the Git backend. ### The working copy is automatically committed -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. +Jujutsu uses a real commit to represent the working copy. Checking out a commit +results a new working-copy commit on top of the target commit. Almost all +commands automatically amend the working-copy commit. + +The working-copy being a commit 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`. 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.