Describe snapshot remove with a remote key when the listing fails
check / check (push) Successful in 13m44s

Given a remote key, `snapshot remove` lists the destination before it
removes anything. When the destination cannot be listed or has no marker
file, it fails and removes nothing. The README and `snapshot remove
--help` said a snapshot in the local index is still removed from it.
That holds only for a snapshot named by its ID.

"The marker file" in `README.md` and `docs/REPOSTRUCTURE.md` now lists
`snapshot remove` with the commands that fail when given a remote key,
or a snapshot ID that is not in the local index.

The `--local-only` sentence in the help ran to 35 words and is split in
two.

Model: fable-5-2
This commit is contained in:
sneak committed 2026-11-17 02:20:35 +00:00
1 parent db06c5eab4
commit 9790e86b90
3 files changed
+28 -12

No files matched your search

+9 -3
View File
@@ -621,14 +621,18 @@ An ID that is in neither the local index nor the destination is an error. With
`--local-only`, the argument must be the ID of a snapshot in the local index.
The deletion at the destination can fail, for example when the destination is
unreachable or has no marker file. What happens then depends on where the
snapshot was:
unreachable or has no marker file. Given a snapshot ID, what happens then
depends on where the snapshot was:
- A snapshot in the local index is still removed from it, with a warning. Run
the same command again later to delete its directory at the destination.
`vaultik prune` does not delete it.
- For a snapshot that is only at the destination, the failure is an error.
Given a remote key, the command lists the destination before it removes
anything. When the destination cannot be listed or has no marker file, the
command fails and removes nothing, not even from the local index.
### `snapshot restore <snapshot-id> <target-dir> [paths...]`
Restores files from a snapshot into `<target-dir>`. The first argument is a
@@ -1173,8 +1177,10 @@ not exist, commands treat the destination as not present:
- `snapshot files`
- `snapshot verify`
- `snapshot restore`
- `snapshot remove`
- `snapshot list` shows the local index alone.
- `snapshot remove` deletes nothing at the destination.
- `snapshot remove` deletes nothing at the destination when given a snapshot ID
that is in the local index.
To fix this, mount the volume. If you emptied the destination on purpose, run
`vaultik database delete` and back up again.
+3 -1
View File
@@ -66,8 +66,10 @@ not exist, commands treat the destination as not present:
- `snapshot files`
- `snapshot verify`
- `snapshot restore`
- `snapshot remove`
- `snapshot list` shows the local index alone.
- `snapshot remove` deletes nothing at the destination.
- `snapshot remove` deletes nothing at the destination when given a snapshot ID
that is in the local index.
The check is skipped when the look-up fails for any other reason. S3 refuses the
look-up to credentials that can only write. A machine with such credentials
+16 -8
View File
@@ -385,15 +385,23 @@ destination store is an error. Needs permission to list and delete
objects on the destination store, unless --local-only is given.
Use --local-only to skip the remote half (e.g. when you want to forget a
snapshot locally without touching the destination store); the argument
must then be the ID of a snapshot in the local index.
snapshot locally without touching the destination store). With
--local-only, the argument must be the ID of a snapshot in the local
index.
If removing the snapshot's metadata from the destination store fails (for
example because the remote is unreachable), the local-database removal
still completes and a warning is emitted; run 'vaultik snapshot remove
<snapshot-id>' again once the destination store is reachable to remove
the snapshot's metadata from it ('vaultik prune' does not). For a
snapshot that is only on the destination store, that failure is an error.
Removing the snapshot's metadata from the destination store can fail,
for example when the destination store is unreachable or has no marker
file (vaultik-destination.txt). Given a snapshot ID, what happens then
depends on where the snapshot was. A snapshot in the local index is
still removed from it, with a warning. Run 'vaultik snapshot remove
<snapshot-id>' again later to remove its metadata from the destination
store. 'vaultik prune' does not remove it. For a snapshot that is only
on the destination store, the failure is an error.
Given a remote key, the command lists the destination store before it
removes anything. When the destination store cannot be listed or has no
marker file, the command fails and removes nothing, not even from the
local index.
To wipe the entire destination store and start over, use 'vaultik remote
nuke --force' — it is the single supported entry point for that.`,