From 80d9b6ae17de1d22f2ec71ece5034096af22cc68 Mon Sep 17 00:00:00 2001
From: Denis Bilenko <denis.bilenko@databricks.com>
Date: Mon, 2 Dec 2024 15:52:43 +0100
Subject: [PATCH] Expand comment on WorktreeRoot

---
 bundle/bundle.go | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/bundle/bundle.go b/bundle/bundle.go
index 18cbba725..b3ef917dc 100644
--- a/bundle/bundle.go
+++ b/bundle/bundle.go
@@ -48,7 +48,10 @@ type Bundle struct {
 	// Exclusively use this field for filesystem operations.
 	SyncRoot vfs.Path
 
-	// Path to the root of git worktree
+	// Path to the root of git worktree containing the bundle.
+	// This is the same as git repository root if worktrees are not used,
+	// otherwise it's a descedant of git repository root.
+	// https://git-scm.com/docs/git-worktree
 	WorktreeRoot vfs.Path
 
 	// Config contains the bundle configuration.