doc(fsrepo): explain ConfigAt

ipfs · Jan 14, 2015 · bd1d876 · bd1d876
1 parent 30a5aa9
commit bd1d876
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/repo/fsrepo/fsrepo.go b/repo/fsrepo/fsrepo.go
@@ -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) {
 
 	// packageLock must be held to ensure that the Read is atomic.