docs: Add parallel worktrees guide#1305
Open
ed-irl wants to merge 4 commits into
Open
Conversation
Collaborator
Author
|
This change is part of the following stack: Change managed by git-spice. |
Update the worktrees guide to match recent anchor and park/restore behavior: - anchor list: describe it as listing registered anchors, the owning worktree, and whether each is a root or internal anchor. - anchor rm / anchor track: note that a worktree cannot remove itself (run from another worktree) and may own only one anchor. - park manifest: record that it now also stores each worktree's HEAD commit, and that a detached-HEAD worktree is restored at that commit. - restore: document recovery when a reorganization deletes or renames a parked branch — restore keeps every other worktree, stays in exclusive mode, and reports the missing branch; recover by re-creating it and re-running restore, or discard with `gs repo restore --forget <path>`. Parked commits are preserved under refs/gs-park/ so they survive garbage collection until recovered.
Regenerates the sync RestackHandler mock so RestackBranch takes the opts *restack.Options parameter introduced downstack. The mock had been generated against the old two-argument signature.
ed-irl
force-pushed
the
ed-irl/repo-exclusive
branch
from
82a6c21 to
6814dc5
Compare
ed-irl
force-pushed
the
ed-irl/anchor-guide
branch
from
2daafd3 to
a33c506
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a guide page (
guide/worktrees.md) covering git-spice's parallel worktree model, and link it into the documentation navigation.The page documents two halves of the model:
gs anchor create), dependent worktrees via--anchor, and managing them withgs anchor list/track/rm.gs repo park/restorehand the whole repository to one process for stack reorganization, including the durable manifest, interrupt-resume behavior, recovery when a parked branch is deleted, and the one-shotgs repo exclusive -- <cmd>wrapper.