Skip to content

Clarify phrasing re: nested/child Git repositories and checkpointing #373

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Clarify phrasing re: nested/child Git repositories and checkpointing #373

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/features/checkpoints.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,9 +202,11 @@ The `.rooignore` file (which controls AI access to files) is separate from check

This separation is intentional, as `.rooignore` limits which files the AI can access, not which files should be tracked for version history.

#### Nested Git Repositories
#### Git Repositories Below the Workspace Root

If nested Git repositories are detected in your workspace, checkpoints are disabled. You'll receive a clear notification when checkpoint initialization fails due to nested repositories. Remove or relocate nested repositories to enable checkpoints.
Checkpoints cannot be enabled if Git repositories exist below the workspace root. If this is detected, checkpoints will be disabled, and you'll receive a clear notification that checkpoint initialization has failed due to this condition. To enable checkpoints, remove or relocate these repositories, or open one of them as your workspace root.

This occurs because the checkpoint service makes use of Git's "worktree" feature, and sets the main worktree directory to the workspace root. In this configuration, any Git repositories in subdirectories will conflict with the main worktree.

### Concurrency Control

Expand Down