Commit bd1d8767 authored by Brian Tiger Chow's avatar Brian Tiger Chow

doc(fsrepo): explain ConfigAt

parent 30a5aa9b
...@@ -71,6 +71,9 @@ func At(repoPath string) *FSRepo { ...@@ -71,6 +71,9 @@ func At(repoPath string) *FSRepo {
} }
} }
// ConfigAt returns an error if the FSRepo at the given path is not
// initialized. This function allows callers to read the config file even when
// another process is running and holding the lock.
func ConfigAt(repoPath string) (*config.Config, error) { func ConfigAt(repoPath string) (*config.Config, error) {
// packageLock must be held to ensure that the Read is atomic. // packageLock must be held to ensure that the Read is atomic.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment