[pbs-devel] [PATCH proxmox-backup] docs: clarify prune settings slightly more

[pbs-devel] [PATCH proxmox-backup] docs: clarify prune settings slightly more

[Fiona Ebner]

The formulation "Keep backups for the last N intervals" might suggest
that intervals without backups also count, which they do not.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
---
 docs/backup-client.rst                  | 20 ++++++++++----------
 docs/maintenance.rst                    | 23 +++++++++++++----------
 docs/prune-simulator/documentation.html | 10 +++++-----
 3 files changed, 28 insertions(+), 25 deletions(-)

diff --git a/docs/backup-client.rst b/docs/backup-client.rst
index 873a6464..f6b459c0 100644
--- a/docs/backup-client.rst
+++ b/docs/backup-client.rst
@@ -632,28 +632,28 @@ following retention options are available:
   Keep the last ``<N>`` backup snapshots.
 
 ``--keep-hourly <N>``
-  Keep backups for the last ``<N>`` hours. If there is more than one
-  backup for a single hour, only the latest is kept.
+  Keep backups for the last ``<N>`` hours. If there is more than one backup for
+  a single hour, only the latest is kept. Hours without backups do not count.
 
 ``--keep-daily <N>``
-  Keep backups for the last ``<N>`` days. If there is more than one
-  backup for a single day, only the latest is kept.
+  Keep backups for the last ``<N>`` days. If there is more than one backup for a
+  single day, only the latest is kept. Days without backups do not count.
 
 ``--keep-weekly <N>``
-  Keep backups for the last ``<N>`` weeks. If there is more than one
-  backup for a single week, only the latest is kept.
+  Keep backups for the last ``<N>`` weeks. If there is more than one backup for
+  a single week, only the latest is kept. Weeks without backup do not count.
 
   .. note:: Weeks start on Monday and end on Sunday. The software
      uses the `ISO week date`_ system and handles weeks at
      the end of the year correctly.
 
 ``--keep-monthly <N>``
-  Keep backups for the last ``<N>`` months. If there is more than one
-  backup for a single month, only the latest is kept.
+  Keep backups for the last ``<N>`` months. If there is more than one backup for
+  a single month, only the latest is kept. Months without backups do not count.
 
 ``--keep-yearly <N>``
-  Keep backups for the last ``<N>`` years. If there is more than one
-  backup for a single year, only the latest is kept.
+  Keep backups for the last ``<N>`` years. If there is more than one backup for
+  a single year, only the latest is kept. Years without backups do not count.
 
 The retention options are processed in the order given above. Each option
 only covers backups within its time period. The next option does not take care
diff --git a/docs/maintenance.rst b/docs/maintenance.rst
index d8a9d27a..6dbb6941 100644
--- a/docs/maintenance.rst
+++ b/docs/maintenance.rst
@@ -13,28 +13,31 @@ The following retention options are available:
   Keep the last ``<N>`` backup snapshots.
 
 ``keep-hourly <N>``
-  Keep backups for the last ``<N>`` hours. If there is more than one
-  backup for a single hour, only the latest is retained.
+  Keep backups for the last ``<N>`` hours. If there is more than one backup for
+  a single hour, only the latest is retained. Hours without backups do not
+  count.
 
 ``keep-daily <N>``
-  Keep backups for the last ``<N>`` days. If there is more than one
-  backup for a single day, only the latest is retained.
+  Keep backups for the last ``<N>`` days. If there is more than one backup for a
+  single day, only the latest is retained. Days without backups do not count.
 
 ``keep-weekly <N>``
-  Keep backups for the last ``<N>`` weeks. If there is more than one
-  backup for a single week, only the latest is retained.
+  Keep backups for the last ``<N>`` weeks. If there is more than one backup for
+  a single week, only the latest is retained. Weeks without backup do not count.
 
   .. note:: Weeks start on Monday and end on Sunday. The software
      uses the `ISO week date`_ system and handles weeks at
      the end of the year correctly.
 
 ``keep-monthly <N>``
-  Keep backups for the last ``<N>`` months. If there is more than one
-  backup for a single month, only the latest is retained.
+  Keep backups for the last ``<N>`` months. If there is more than one backup for
+  a single month, only the latest is retained. Months without backups do not
+  count.
 
 ``keep-yearly <N>``
-  Keep backups for the last ``<N>`` years. If there is more than one
-  backup for a single year, only the latest is retained.
+  Keep backups for the last ``<N>`` years. If there is more than one backup for
+  a single year, only the latest is retained. Years without backups do not
+  count.
 
 The retention options are processed in the order given above. Each option
 only covers backups within its time period. The next option does not take care
diff --git a/docs/prune-simulator/documentation.html b/docs/prune-simulator/documentation.html
index 536f77c2..d8b15676 100644
--- a/docs/prune-simulator/documentation.html
+++ b/docs/prune-simulator/documentation.html
@@ -82,13 +82,13 @@ available:</p>
 <dd>Keep the last <code class="docutils literal notranslate"><span class="pre">&lt;N&gt;</span></code> backup snapshots.</dd>
 <dt><code class="docutils literal notranslate"><span class="pre">keep-hourly</span> <span class="pre">&lt;N&gt;</span></code></dt>
 <dd>Keep backups for the last <code class="docutils literal notranslate"><span class="pre">&lt;N&gt;</span></code> hours. If there is more than one
-backup for a single hour, only the latest is kept.</dd>
+backup for a single hour, only the latest is kept. Hours without backups do not count.</dd>
 <dt><code class="docutils literal notranslate"><span class="pre">keep-daily</span> <span class="pre">&lt;N&gt;</span></code></dt>
 <dd>Keep backups for the last <code class="docutils literal notranslate"><span class="pre">&lt;N&gt;</span></code> days. If there is more than one
-backup for a single day, only the latest is kept.</dd>
+backup for a single day, only the latest is kept. Days without backups do not count.</dd>
 <dt><code class="docutils literal notranslate"><span class="pre">keep-weekly</span> <span class="pre">&lt;N&gt;</span></code></dt>
 <dd>Keep backups for the last <code class="docutils literal notranslate"><span class="pre">&lt;N&gt;</span></code> weeks. If there is more than one
-backup for a single week, only the latest is kept.
+backup for a single week, only the latest is kept. Weeks without backups do not count.
 <div class="last admonition note">
 <p class="note-title">Note:</p>
 <p class="last">Weeks start on Monday and end on Sunday. The software
@@ -98,10 +98,10 @@ the end of the year correctly.</p>
 </dd>
 <dt><code class="docutils literal notranslate"><span class="pre">keep-monthly</span> <span class="pre">&lt;N&gt;</span></code></dt>
 <dd>Keep backups for the last <code class="docutils literal notranslate"><span class="pre">&lt;N&gt;</span></code> months. If there is more than one
-backup for a single month, only the latest is kept.</dd>
+backup for a single month, only the latest is kept. Months without backups do not count.</dd>
 <dt><code class="docutils literal notranslate"><span class="pre">keep-yearly</span> <span class="pre">&lt;N&gt;</span></code></dt>
 <dd>Keep backups for the last <code class="docutils literal notranslate"><span class="pre">&lt;N&gt;</span></code> years. If there is more than one
-backup for a single year, only the latest is kept.</dd>
+backup for a single year, only the latest is kept. Years without backups do not count.</dd>
 </dl>
 <p>The retention options are processed in the order given above. Each option
 only covers backups within its time period. The next option does not take care
-- 
2.39.2

[pbs-devel] applied: [PATCH proxmox-backup] docs: clarify prune settings slightly more

[Dietmar Maurer]

applied