mirror of
https://github.com/privatevoid-net/nix-super.git
synced 2025-01-31 23:46:48 +02:00
One line per sentence in markdown docs.
This commit is contained in:
parent
f2fe9822c1
commit
f5d83a8029
2 changed files with 12 additions and 16 deletions
|
@ -52,14 +52,14 @@ struct LocalStoreConfig : virtual LocalFSStoreConfig
|
||||||
R"(
|
R"(
|
||||||
Allow this store to be opened when its [database](@docroot@/glossary.md#gloss-nix-database) is on a read-only filesystem.
|
Allow this store to be opened when its [database](@docroot@/glossary.md#gloss-nix-database) is on a read-only filesystem.
|
||||||
|
|
||||||
Normally Nix will attempt to open the store database in read-write mode, even
|
Normally Nix will attempt to open the store database in read-write mode, even for querying (when write access is not needed).
|
||||||
for querying (when write access is not needed). This causes it to fail if the
|
This causes it to fail if the database is on a read-only filesystem.
|
||||||
database is on a read-only filesystem.
|
|
||||||
|
|
||||||
Enable read-only mode to disable locking and open the SQLite database with the
|
Enable read-only mode to disable locking and open the SQLite database with the [`immutable` parameter](https://www.sqlite.org/c3ref/open.html) set.
|
||||||
[`immutable` parameter](https://www.sqlite.org/c3ref/open.html) set. Do not use this unless the filesystem is read-only.
|
|
||||||
Using it when the filesystem is writable can cause incorrect query results or
|
**Warning**
|
||||||
corruption errors if the database is changed by another process.
|
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"; }
|
||||||
|
|
|
@ -220,17 +220,13 @@ constexpr std::array<ExperimentalFeatureDetails, 14> xpFeatureDetails = {{
|
||||||
.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
|
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.
|
||||||
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
|
This is because SQLite requires write access to the database file to perform the file locking operations necessary for safe concurrent access.
|
||||||
the file locking operations necessary for safe concurrent access. When `read-only`
|
When `read-only` is set to `true`, the database will be opened in immutable mode.
|
||||||
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
|
Under this mode, SQLite will not do any locking at all, so you should be certain that the database will not be changed.
|
||||||
that the database will not be changed. While the filesystem the database resides
|
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.
|
||||||
on might be read-only to this process, consider whether another user, process,
|
|
||||||
or system, might have write access to it.
|
|
||||||
)",
|
)",
|
||||||
},
|
},
|
||||||
}};
|
}};
|
||||||
|
|
Loading…
Reference in a new issue