[pbs-devel] [PATCH proxmox-backup 9/9] docs: mention gc-wait-period option as datastore tuning parameter

[Christian Ebner]

Document the gc-wait-period option and describe the behavior it
controls, by adding it as additional bullet point to the documented
datastore tuning options.

Signed-off-by: Christian Ebner <c.ebner at proxmox.com>
---
changes since version 1:
- not present in previous version

 docs/storage.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/docs/storage.rst b/docs/storage.rst
index 9e2ff4a5e..9f7039d3f 100644
--- a/docs/storage.rst
+++ b/docs/storage.rst
@@ -446,6 +446,12 @@ There are some tuning related options for the datastore that are more advanced:
   data loss by unexpected filesystem behaviour. It is recommended to set this to
   enabled, which is also the default value.
 
+* ``gc-wait-period``: Datastore GC wait period:
+  This allows to set the wait period for which a chunk is still considered
+  in-use during phase 2 of garbage collection (given no older writers). If the
+  ``atime`` of the chunk is outside the range, it will be removed. This option
+  is only used in combination with the ``gc-atime-check`` being enabled.
+
 If you want to set multiple tuning options simultaneously, you can separate them
 with a comma, like this:
 
-- 
2.39.5