doc(fsrepo): explain ConfigAt
Brian Tiger Chow committed
Jan 14, 2015 at 10:06 UTC
bd1d8767eb0810de66ee5b226b937d7c81a29e13
1 file changed
+3
repo/fsrepo/fsrepo.go
+3
@@ -71,6 +71,9 @@ func At(repoPath string) *FSRepo {
71
}
72
}
73
74
+// ConfigAt returns an error if the FSRepo at the given path is not
75
+// initialized. This function allows callers to read the config file even when
76
+// another process is running and holding the lock.
77
func ConfigAt(repoPath string) (*config.Config, error) {
78
79
// packageLock must be held to ensure that the Read is atomic.