From dd4271e1c5189d69734a7953a3ddf19c8903c2eb Mon Sep 17 00:00:00 2001 From: Michal Suchanek Date: Fri, 10 Oct 2025 19:04:57 +0200 Subject: [PATCH 1/2] doc: git-worktree: Link to examples Also add advice to put new worktrees outside of existing ones. Signed-off-by: Michal Suchanek Signed-off-by: Junio C Hamano --- Documentation/git-worktree.adoc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Documentation/git-worktree.adoc b/Documentation/git-worktree.adoc index 8340b7f028..05cc8c3933 100644 --- a/Documentation/git-worktree.adoc +++ b/Documentation/git-worktree.adoc @@ -79,6 +79,9 @@ with a matching name, treat as equivalent to: $ git worktree add --track -b / ------------ + +For best results it is advised to specify __ outside of the repository +and existing worktrees - see <> ++ If the branch exists in multiple remotes and one of them is named by the `checkout.defaultRemote` configuration variable, we'll use that one for the purposes of disambiguation, even if the `` isn't @@ -498,6 +501,7 @@ locked "reason\nwhy is locked" ... ------------ +[[EXAMPLES]] EXAMPLES -------- You are in the middle of a refactoring session and your boss comes in and From b0380a8ebccc00ff7205c899d58e403c640408b0 Mon Sep 17 00:00:00 2001 From: Michal Suchanek Date: Fri, 10 Oct 2025 19:04:58 +0200 Subject: [PATCH 2/2] doc: git-worktree: Add side by side branch checkout example Signed-off-by: Michal Suchanek Signed-off-by: Junio C Hamano --- Documentation/git-worktree.adoc | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/Documentation/git-worktree.adoc b/Documentation/git-worktree.adoc index 05cc8c3933..692e81fe3a 100644 --- a/Documentation/git-worktree.adoc +++ b/Documentation/git-worktree.adoc @@ -522,6 +522,16 @@ $ popd $ git worktree remove ../temp ------------ +Side by side branch checkouts for a repository using multiple worktrees + +------------ +mkdir some-repository +cd some-repository +git clone --bare gitforge@someforge.example.com:some-org/some-repository some-repository.git +git --git-dir=some-repository.git worktree add some-branch +git --git-dir=some-repository.git worktree add another-branch +------------ + BUGS ---- Multiple checkout in general is still experimental, and the support