More detailed explanation of check-mount setting.

This commit is contained in:
Ben Radford 2023-05-16 13:10:25 +01:00
parent 0ec7f2fb3f
commit 4d69bd034a
No known key found for this signature in database
GPG key ID: 9DF5D4640AB888D5

View file

@ -31,7 +31,15 @@ struct LocalOverlayStoreConfig : virtual LocalStoreConfig
)"};
Setting<bool> checkMount{(StoreConfig*) this, true, "check-mount",
"Check that the overlay filesystem is correctly mounted."};
R"(
Check that the overlay filesystem is correctly mounted.
Nix does not manage the overlayfs mount point itself, but the correct
functioning of the overlay store does depend on this mount point being set up
correctly. Rather than just assume this is the case, check that the lowerdir
and upperdir options are what we expect them to be. This check is on by
default, but can be disabled if needed.
)"};
const std::string name() override { return "Experimental Local Overlay Store"; }