[pbs-devel] [PATCH proxmox-backup v2 2/4] chunk store: fix and expand the clear_chunk_expected_mark() docstring

[Christian Ebner]

The sentence was grammatically wrong and did not provide to much
context on what this is used for. Fix and extend the docstring.

Reported-by: Thomas Lamprecht <t.lamprecht at proxmox.com>
Signed-off-by: Christian Ebner <c.ebner at proxmox.com>
---
Changes since version 1:
- not present

 pbs-datastore/src/chunk_store.rs | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/pbs-datastore/src/chunk_store.rs b/pbs-datastore/src/chunk_store.rs
index f10415d1f..143848838 100644
--- a/pbs-datastore/src/chunk_store.rs
+++ b/pbs-datastore/src/chunk_store.rs
@@ -749,7 +749,12 @@ impl ChunkStore {
         Ok(())
     }
 
-    /// Remove chunk as required mark by removing file the chunk store.
+    /// Remove the chunk-expected marker file from the chunk store.
+    ///
+    /// Used to remove the chunk-expected marker file during phase 2 of garbage collection. This
+    /// marker file is created during phase 1 of garbage collection in case the chunk or its zero
+    /// size marker file is not found in the chunk store, but still referenced by an index file,
+    /// flagging it as still required.
     ///
     /// Returns true if the file was present and removed, false if the file did not exist.
     pub(crate) fn clear_chunk_expected_mark(&self, digest: &[u8; 32]) -> Result<bool, Error> {
-- 
2.47.3