mirror of
https://github.com/privatevoid-net/nix-super.git
synced 2024-11-10 08:16:15 +02:00
Document remount-hook store parameter.
This commit is contained in:
parent
c409a753db
commit
c712369ec5
1 changed files with 8 additions and 2 deletions
|
@ -43,9 +43,15 @@ struct LocalOverlayStoreConfig : virtual LocalStoreConfig
|
|||
|
||||
const PathSetting remountHook{(StoreConfig*) this, "", "remount-hook",
|
||||
R"(
|
||||
Script or program to run when overlay filesystem needs remounting.
|
||||
Script or other executable to run when overlay filesystem needs remounting.
|
||||
|
||||
TODO: Document this in more detail.
|
||||
This is occasionally necessary when deleting a store path that exists in both upper and lower layers.
|
||||
In such a situation, bypassing OverlayFS and deleting the path in the upper layer directly
|
||||
is the only way to perform the deletion without creating a "whiteout".
|
||||
However this causes the OverlayFS kernel data structures to get out-of-sync,
|
||||
and can lead to 'stale file handle' errors; remounting solves the problem.
|
||||
|
||||
The store directory is passed as an argument to the invoked executable.
|
||||
)"};
|
||||
|
||||
const std::string name() override { return "Experimental Local Overlay Store"; }
|
||||
|
|
Loading…
Reference in a new issue