max/nix-super
1
0
Fork 0
mirror of https://github.com/privatevoid-net/nix-super.git synced 2024-11-10 16:26:18 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document the new read-only local store setting.

Browse source
This commit is contained in:
Ben Radford 2023-05-17 08:49:51 +01:00
parent b1a7b26eef
commit 5966b76c97
No known key found for this signature in database
GPG key ID: 9DF5D4640AB888D5
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
src/libstore/local-store.hh
View file

@ -49,7 +49,18 @@ struct LocalStoreConfig : virtual LocalFSStoreConfig
Setting<bool> readOnly{(StoreConfig*) this,
false,
"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"; }