docs: Add documentation for minutely keep option (#1371)

Adds documentation for the minutely timeline (rustic-rs/rustic_core#374) in `./config/full.toml` and `./config/README.md` Co-authored-by: simonsan <14062932+simonsan@users.noreply.github.com>
rustic-rs · Nov 30, 2024 · 11b772d · 11b772d
1 parent d6214c4
commit 11b772d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/config/README.md b/config/README.md
@@ -245,13 +245,15 @@ hooks when backing up the defined sources into a snapshot.
 | -------------------------- | ----------------------------------------------------------------------- | ------------------ | ---------------------- | ---------------------------- |
 | group-by                   | Group snapshots by given criteria before applying keep policies.        | "host,label,paths" |                        | --group-by                   |
 | keep-last                  | Number of most recent snapshots to keep.                                | Not set            | 15                     | --keep-last, -l              |
+| keep-minutely, -M          | Number of minutely snapshots to keep.                                   | Not set            |                        | --keep-minutely              |
 | keep-hourly, -H            | Number of hourly snapshots to keep.                                     | Not set            |                        | --keep-hourly                |
 | keep-daily, -d             | Number of daily snapshots to keep.                                      | Not set            | 8                      | --keep-daily                 |
 | keep-weekly, -w            | Number of weekly snapshots to keep.                                     | Not set            |                        | --keep-weekly                |
 | keep-monthly, -m           | Number of monthly snapshots to keep.                                    | Not set            |                        | --keep-monthly               |
 | keep-quarter-yearly        | Number of quarter-yearly snapshots to keep.                             | Not set            |                        | --keep-quarter-yearly        |
 | keep-half-yearly           | Number of half-yearly snapshots to keep.                                | Not set            |                        | --keep-half-yearly           |
 | keep-yearly, -y            | Number of yearly snapshots to keep.                                     | Not set            |                        | --keep-yearly                |
+| keep-within-minutely       | The time duration within which minutely snapshots will be kept.         | Not set            | "2 hours"              | --keep-within-minutely       |
 | keep-within-hourly         | The time duration within which hourly snapshots will be kept.           | Not set            | "1 day"                | --keep-within-hourly         |
 | keep-within-daily          | The time duration within which daily snapshots will be kept.            | Not set            | "7 days"               | --keep-within-daily          |
 | keep-within-weekly         | The time duration within which weekly snapshots will be kept.           | Not set            |                        | --keep-within-weekly         |

diff --git a/config/full.toml b/config/full.toml
@@ -181,13 +181,15 @@ keep-ids = [
   "11122233",
 ] # Keep all snapshots whose ID starts with any of these strings, default: not set
 keep-last = 0
+keep-minutely = 10
 keep-daily = 3
 keep-weekly = 0
 keep-monthly = 0
 keep-quarter-yearly = 0
 keep-half-yearly = 0
 keep-yearly = 10
 keep-within = "0s"
+keep-within-minutely = "2 hours"
 keep-within-daily = "0 seconds"
 keep-within-weekly = "2 months"
 keep-within-monthly = "1 year"