From cde491e5767caca7bf10bca16d625e713ba24a9b Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Sun, 19 Jun 2016 22:04:31 +0900 Subject: docs on property ordering --- src/Propellor/Property/Schroot.hs | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'src/Propellor/Property/Schroot.hs') diff --git a/src/Propellor/Property/Schroot.hs b/src/Propellor/Property/Schroot.hs index bb20f6e6..20c98e60 100644 --- a/src/Propellor/Property/Schroot.hs +++ b/src/Propellor/Property/Schroot.hs @@ -18,6 +18,17 @@ data UseOverlays = UseOverlays deriving (Eq, Show, Typeable) -- Setting this property does not actually ensure that the line -- @union-type=overlay@ is present in any schroot config files. See -- 'Propellor.Property.Sbuild.built' for example usage. +-- +-- You should apply this property to a host before any properties that can use +-- overlays. For example, use +-- +-- > & Schroot.useOverlays +-- > & Sbuild.builtFor (System (Debian Unstable) X86_32) +-- +-- rather than +-- +-- > & Sbuild.builtFor (System (Debian Unstable) X86_32) +-- > & Schroot.useOverlays useOverlays :: Property (HasInfo + UnixLike) useOverlays = pureInfoProperty "use schroot overlays" (InfoVal UseOverlays) @@ -29,7 +40,9 @@ usesOverlays = isJust . fromInfoVal -- | Configure schroot such that all schroots with @union-type=overlay@ in their -- configuration will run their overlays in a tmpfs. -- --- Implicitly sets 'useOverlays' info property. +-- Implicitly sets 'useOverlays' info property. Like that property, you should +-- apply 'overlaysInTmpfs' to a host before applying any properties that can use +-- overlays (e.g. 'Propellor.Property.Sbuild.built'). -- -- Shell script from . overlaysInTmpfs :: Property (HasInfo + DebianLike) -- cgit v1.3-2-g0d8e