summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSean Whitton2016-06-19 22:04:31 +0900
committerSean Whitton2016-06-19 22:04:31 +0900
commitcde491e5767caca7bf10bca16d625e713ba24a9b (patch)
treebaca81c5534157563a33c2e877d0a6a9d16d0715
parentd436af8f42e05272e369af3f69a65bac157db725 (diff)
docs on property ordering
-rw-r--r--src/Propellor/Property/Sbuild.hs2
-rw-r--r--src/Propellor/Property/Schroot.hs15
2 files changed, 15 insertions, 2 deletions
diff --git a/src/Propellor/Property/Sbuild.hs b/src/Propellor/Property/Sbuild.hs
index 5d58a84a..bb1a2a0a 100644
--- a/src/Propellor/Property/Sbuild.hs
+++ b/src/Propellor/Property/Sbuild.hs
@@ -9,12 +9,12 @@ Build and maintain schroots for use with sbuild.
Suggested usage in @config.hs@:
> & Apt.installed ["piuparts", "autopkgtest"]
+> & Schroot.overlaysInTmpfs
> & Sbuild.builtFor (System (Debian Unstable) X86_32)
> & Sbuild.piupartsConfFor (System (Debian Unstable) X86_32)
> & Sbuild.updatedFor (System (Debian Unstable) X86_32) `period` Weekly 1
> & Sbuild.usableBy (User "spwhitton")
> & Sbuild.shareAptCache
-> & Schroot.overlaysInTmpfs
In @~/.sbuildrc@:
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 <https://wiki.debian.org/sbuild>.
overlaysInTmpfs :: Property (HasInfo + DebianLike)