From: Fiona Ebner <f.ebner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup] docs: clarify prune settings slightly more
Date: Tue, 20 Feb 2024 16:25:56 +0100 [thread overview]
Message-ID: <20240220152556.49885-1-f.ebner@proxmox.com> (raw)
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
next reply other threads:[~2024-02-20 15:26 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-20 15:25 Fiona Ebner [this message]
2024-02-22 7:59 ` [pbs-devel] applied: " Dietmar Maurer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240220152556.49885-1-f.ebner@proxmox.com \
--to=f.ebner@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox