From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <f.ebner@proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
key-exchange X25519 server-signature RSA-PSS (2048 bits))
(No client certificate requested)
by lists.proxmox.com (Postfix) with ESMTPS id 12B3A939E9
for <pbs-devel@lists.proxmox.com>; Tue, 20 Feb 2024 16:26:03 +0100 (CET)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id E8896A156
for <pbs-devel@lists.proxmox.com>; Tue, 20 Feb 2024 16:26:02 +0100 (CET)
Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com
[94.136.29.106])
(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
key-exchange X25519 server-signature RSA-PSS (2048 bits))
(No client certificate requested)
by firstgate.proxmox.com (Proxmox) with ESMTPS
for <pbs-devel@lists.proxmox.com>; Tue, 20 Feb 2024 16:26:02 +0100 (CET)
Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1])
by proxmox-new.maurer-it.com (Proxmox) with ESMTP id E485F43CAC
for <pbs-devel@lists.proxmox.com>; Tue, 20 Feb 2024 16:26:01 +0100 (CET)
From: Fiona Ebner <f.ebner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Date: Tue, 20 Feb 2024 16:25:56 +0100
Message-Id: <20240220152556.49885-1-f.ebner@proxmox.com>
X-Mailer: git-send-email 2.39.2
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-SPAM-LEVEL: Spam detection results: 0
AWL -0.071 Adjusted score from AWL reputation of From: address
BAYES_00 -1.9 Bayes spam probability is 0 to 1%
DMARC_MISSING 0.1 Missing DMARC policy
KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record
SPF_PASS -0.001 SPF: sender matches SPF record
T_SCC_BODY_TEXT_LINE -0.01 -
Subject: [pbs-devel] [PATCH proxmox-backup] docs: clarify prune settings
slightly more
X-BeenThere: pbs-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox Backup Server development discussion
<pbs-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pbs-devel/>
List-Post: <mailto:pbs-devel@lists.proxmox.com>
List-Help: <mailto:pbs-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=subscribe>
X-List-Received-Date: Tue, 20 Feb 2024 15:26:03 -0000
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"><N></span></code> backup snapshots.</dd>
<dt><code class="docutils literal notranslate"><span class="pre">keep-hourly</span> <span class="pre"><N></span></code></dt>
<dd>Keep backups for the last <code class="docutils literal notranslate"><span class="pre"><N></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"><N></span></code></dt>
<dd>Keep backups for the last <code class="docutils literal notranslate"><span class="pre"><N></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"><N></span></code></dt>
<dd>Keep backups for the last <code class="docutils literal notranslate"><span class="pre"><N></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"><N></span></code></dt>
<dd>Keep backups for the last <code class="docutils literal notranslate"><span class="pre"><N></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"><N></span></code></dt>
<dd>Keep backups for the last <code class="docutils literal notranslate"><span class="pre"><N></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