datastore: reduce chunk store open visibility and comment pitfalls

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>

diff --git a/pbs-datastore/src/chunk_store.rs b/pbs-datastore/src/chunk_store.rs
index c142c05a9d245b4aca42f35c1a16dd41f7ca3d98..c9714c1e0131a3700700f1d649709ee26a42ce4c 100644 (file)
--- a/pbs-datastore/src/chunk_store.rs
+++ b/pbs-datastore/src/chunk_store.rs
@@ -153,7 +153,12 @@ impl ChunkStore {
         lockfile_path
     }
 
-    pub fn open<P: Into<PathBuf>>(name: &str, base: P) -> Result<Self, Error> {
+    /// Opens the chunk store with a new process locker.
+    ///
+    /// Note that this must be used with care, as it's dangerous to create two instances on the
+    /// same base path, as closing the underlying ProcessLocker drops all locks from this process
+    /// on the lockfile (even if separate FDs)
+    pub(crate) fn open<P: Into<PathBuf>>(name: &str, base: P) -> Result<Self, Error> {
         let base: PathBuf = base.into();
 
         if !base.is_absolute() {