From c1c8703ef9fa64857841da4c6c7a12fed44b671b Mon Sep 17 00:00:00 2001 From: Khionu Sybiern Date: Thu, 7 Mar 2024 13:16:16 -0800 Subject: [PATCH] docs: add FAQ for why to use new-then-amend over edit --- docs/FAQ.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/FAQ.md b/docs/FAQ.md index 0315c701b5..6fe001fa93 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -137,6 +137,17 @@ commit, then run `jj restore --from Y --to @-` to restore the parent commit to the old state, and `jj restore --from X` to restore the new working-copy commit to the new state. +### How do I resume working on an existing change? + +There are two ways to resume working on an earlier change: `jj new` then `jj amend`, +and `jj edit`. The first is recommended over the second for a few reasons, which +come down to how intentional you are with your changes. If the change you want to +resume working on has a conflict, `jj edit` would restore the state with plain-text +conflict annotations. Editing those annotations incorrectly or by accident can lead +to undefined behaviour during conflict resolution. If you amend a new change onto +a change that contains a conflict, the conflict will be updated to correctly reflect +your new changes. + ### How do I deal with divergent changes ('??' after the [change ID])? A [divergent change][glossary_divergent_change] represents a change that has two