aboutsummaryrefslogtreecommitdiffstats
path: root/options.go
diff options
context:
space:
mode:
authorTimofey Kirillov <timofey.kirillov@flant.com>2019-03-28 20:32:01 +0000
committerTimofey Kirillov <timofey.kirillov@flant.com>2020-06-15 17:16:42 +0300
commit63c42e530e9ffdf070f74a2674aa1a1fc24703a8 (patch)
tree41daf4cb42a97aa209f198e0b5299e048957d80f /options.go
parent5cafe4097c72c0673255fdf8cac44fc513c6042c (diff)
downloadgo-git-63c42e530e9ffdf070f74a2674aa1a1fc24703a8.tar.gz
Support `.git/commondir` repository layout
Git creates `.git/commondir` when there are custom worktrees (see "git worktree add" related commands). `.git/commondir` in such case contains a link to another dot-git repository tree, which could contain some folders like: - objects; - config; - refs; - etc. In this PR a new dotgit.RepositoryFilesystem struct is defined, which is billy.Filesystem interface compatible object-wrapper, that can handle commondir and dispatch all operations to the correct file path. `git.PlainOpen` remain unchanged, but `git.PlainOpenWithOptions` has a new option: `PlainOpenOptions.EnableDotGitCommonDir=true|false` (which is false by default). When `EnableDotGitCommonDir=true` repository-open procedure will read `.git/commondir` (if it exists) and then create dotgit.RepositoryFilesystem object initialized with 2 filesystems. This object then passed into storage and then into dotgit.DotGit as `billy.Filesystem` interface. This object will catch all filesystem operations and dispatch to the correct repository-filesystem (dot-git or common-dot-git) according to the rules described in the doc: https://git-scm.com/docs/gitrepository-layout#Documentation/gitrepository-layout.txt. EnableDotGitCommonDir option will only work with the filesystem-backed storage. Also worktree_test.go has been adopted from an older, already existing existing PR: https://github.com/src-d/go-git/pull/1098. This PR needs new fixtures added in the following PR: https://github.com/go-git/go-git-fixtures/pull/1.
Diffstat (limited to 'options.go')
-rw-r--r--options.go3
1 files changed, 3 insertions, 0 deletions
diff --git a/options.go b/options.go
index 8495e97..2f93631 100644
--- a/options.go
+++ b/options.go
@@ -602,6 +602,9 @@ type PlainOpenOptions struct {
// DetectDotGit defines whether parent directories should be
// walked until a .git directory or file is found.
DetectDotGit bool
+ // Enable .git/commondir support (see https://git-scm.com/docs/gitrepository-layout#Documentation/gitrepository-layout.txt).
+ // NOTE: This option will only work with the filesystem storage.
+ EnableDotGitCommonDir bool
}
// Validate validates the fields and sets the default values.