Document snapshot files and fix the six findings of the last review
Rebased onto next, which added `snapshot files` and refuses an exclude pattern that does not compile. The README, docs/REPOSTRUCTURE.md, the example config and the help text now name `snapshot files` wherever they list the commands that need the private key, read or list the destination, run without the lock or write a decrypted database. The config load conditions name exclude patterns, and docs/ARCHITECTURE.md lists internal/exclude. The six findings of #399 (comment) use the wording that review gives. Model: opus-5-5
This commit is contained in:
1 parent
3d5c35d2c1
commit
45d775709d
7 files changed
+145
-48
No files matched your search
@@ -16,7 +16,7 @@ Two other documents cover the stored data:
|
||||
## Terms
|
||||
|
||||
- **Snapshot**: one backup of the paths listed under one name in the config.
|
||||
- **Snapshot ID**: the name of a snapshot, in the form
|
||||
- **Snapshot ID**: the identifier of one snapshot, in the form
|
||||
`<hostname>_<snapshot-name>_<timestamp>`.
|
||||
- **Chunk**: a piece of a file's content. A chunk is named by the SHA-256 hash
|
||||
of its content.
|
||||
@@ -69,6 +69,8 @@ source files
|
||||
S3, a local directory and [rclone](https://rclone.org/).
|
||||
- `internal/s3`: the S3 client that the S3 `Storer` uses.
|
||||
- `internal/config`: loads and checks the config file.
|
||||
- `internal/exclude`: compiles exclude patterns, for the config check and for
|
||||
the `Scanner`.
|
||||
- `internal/ui`: formats the status lines, warnings and errors a user sees.
|
||||
- `internal/log`: the logger. It writes to stderr.
|
||||
- `internal/pidlock`: the lock that `RunWithApp` takes for a command that
|
||||
|
||||
Reference in new issue
Block a user