Remove redundant description on experimental flag.

This commit is contained in:
Ben Radford 2023-06-19 13:47:21 +01:00
parent feb8d552ae
commit ef40448b1c
No known key found for this signature in database
GPG key ID: 9DF5D4640AB888D5
2 changed files with 1 additions and 8 deletions

View file

@ -59,6 +59,7 @@ struct LocalStoreConfig : virtual LocalFSStoreConfig
**Warning** **Warning**
Do not use this unless the filesystem is read-only. 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. Using it when the filesystem is writable can cause incorrect query results or corruption errors if the database is changed by another process.
While the filesystem the database resides on might appear to be read-only, consider whether another user or system might have write access to it.
)"}; )"};
const std::string name() override { return "Local Store"; } const std::string name() override { return "Local Store"; }

View file

@ -226,14 +226,6 @@ constexpr std::array<ExperimentalFeatureDetails, 15> xpFeatureDetails = {{
.name = "read-only-local-store", .name = "read-only-local-store",
.description = R"( .description = R"(
Allow the use of the `read-only` parameter in local store URIs. Allow the use of the `read-only` parameter in local store URIs.
Set this parameter to `true` to allow stores with databases on read-only filesystems to be opened for querying; ordinarily Nix will refuse to do this.
This is because SQLite requires write access to the database file to perform the file locking operations necessary for safe concurrent access.
When `read-only` is set to `true`, the database will be opened in immutable mode.
Under this mode, SQLite will not do any locking at all, so you should be certain that the database will not be changed.
While the filesystem the database resides on might be read-only to this process, consider whether another user, process, or system, might have write access to it.
)", )",
}, },
}}; }};