Split the long README sentences the --prune bullet's edit touched
check / check (push) Waiting to run

The --prune bullet in README.md held sentences of 45 to 75 words that
this branch edits or reflows, and it said the missing-volume case exits
non-zero beside two cases that name their status. Each is now split
into short sentences, and that case says it exits 1.

Model: opus-5-5
This commit is contained in:
sneak committed 2026-11-19 06:49:47 +00:00
1 parent 7f3fb97012
commit 28a272903f
1 file changed
+18 -17
+18 -17
View File
@@ -361,24 +361,25 @@ In such a config, an unknown key or a value of the wrong type is refused.
local index, as `prune` does. By default keeps only the latest snapshot per local index, as `prune` does. By default keeps only the latest snapshot per
name; use `--keep-newer-than` for a rolling window. When `--skip-errors` name; use `--keep-newer-than` for a rolling window. When `--skip-errors`
skipped a file or directory it could not read or list, the prune does not run skipped a file or directory it could not read or list, the prune does not run
and every older snapshot is kept, since one of them may be the only one that and every older snapshot is kept. One of them may be the only one that holds
holds what was skipped; the command says so and exits `3`. When the backup what was skipped. The command says so and exits `3`. The prune does not run
found nothing in a configured path, as in the mount point of a volume that is either when the backup found nothing in a configured path, as in the mount
not mounted, the prune does not run either: every older snapshot is kept, and point of a volume that is not mounted. Every older snapshot is kept, and the
the command names the path and exits `1`, on every run until the path holds command names the path and exits `1`, on every run until the path holds
something again. Take a path that is empty on purpose out of the config, or something again. Take a path that is empty on purpose out of the config, or
remove the older snapshots by hand with `snapshot purge`. When an earlier remove the older snapshots by hand with `snapshot purge`. The prune does not
snapshot of the same name in the local index found a volume mounted at or run either when this backup does not find a volume that an earlier snapshot of
below a configured path (a directory on a different filesystem from its the same name in the local index found. The volume's mount point is a
parent, with an entry in it that the backup does not exclude) and this backup directory at or below a configured path. That directory is on a different
does not, the prune does not run either: every older snapshot is kept, and the filesystem from its parent and holds an entry the backup does not exclude.
command names the directory and exits non-zero, on every run until the volume Every older snapshot is kept, and the command names the directory and exits
is mounted again. A backup also does not find the volume when it finds no such `1`, on every run until the volume is mounted again. A backup also does not
entry in its directory, as when an automounted volume cannot be mounted, or find the volume when it finds no such entry in its directory, as when an
when that directory is no longer backed up, because it is excluded or its automounted volume cannot be mounted. Nor does it find the volume when that
configured path was removed. If any of this is on purpose, as for a retired directory is no longer backed up, because it is excluded or its configured
volume, remove the older snapshots by hand with `snapshot purge`. A file path was removed. If any of this is on purpose, as for a retired volume,
removed during the backup does not stop the prune. remove the older snapshots by hand with `snapshot purge`. A file removed
during the backup does not stop the prune.
- `--keep-newer-than <duration>`: With `--prune`, keep snapshots newer than this - `--keep-newer-than <duration>`: With `--prune`, keep snapshots newer than this
duration instead of only the latest (e.g. `4w`, `30d`, `6mo`, `1y`). Without duration instead of only the latest (e.g. `4w`, `30d`, `6mo`, `1y`). Without
`--prune`, or with a value that is not a valid duration, the command fails `--prune`, or with a value that is not a valid duration, the command fails