mirror of
https://github.com/privatevoid-net/nix-super.git
synced 2025-02-01 07:56:47 +02:00
Document the new read-only local store setting.
This commit is contained in:
parent
b1a7b26eef
commit
5966b76c97
1 changed files with 12 additions and 1 deletions
|
@ -49,7 +49,18 @@ struct LocalStoreConfig : virtual LocalFSStoreConfig
|
||||||
Setting<bool> readOnly{(StoreConfig*) this,
|
Setting<bool> readOnly{(StoreConfig*) this,
|
||||||
false,
|
false,
|
||||||
"read-only",
|
"read-only",
|
||||||
"TODO"};
|
R"(
|
||||||
|
Allow this store to be opened when its database is on a read-only filesystem.
|
||||||
|
|
||||||
|
Normally Nix will attempt to open the store database in read-write mode, even
|
||||||
|
for querying (when write access is not needed). This causes it to fail if the
|
||||||
|
database is on a read-only filesystem.
|
||||||
|
|
||||||
|
Enable read-only mode to disable locking and open the SQLite database with the
|
||||||
|
**imutable** parameter set. Do not use this unless the filesystem is read-only.
|
||||||
|
Using it when the filesystem is writable can cause incorrect query results or
|
||||||
|
corruption errors if the database is changed by another process.
|
||||||
|
)"};
|
||||||
|
|
||||||
const std::string name() override { return "Local Store"; }
|
const std::string name() override { return "Local Store"; }
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue