summaryrefslogtreecommitdiff
path: root/src/Propellor/Property/Chroot.hs
diff options
context:
space:
mode:
authorJoey Hess2015-10-23 01:27:22 -0400
committerJoey Hess2015-10-23 01:27:22 -0400
commit1a55d09b5452f07508d4624b632e9a54782dbee8 (patch)
treebb8d78846ea10de6b53f15a445e140dc7503dba3 /src/Propellor/Property/Chroot.hs
parentb689acd7ad6abb40fdfff628a424bb156f178c76 (diff)
export ChrootTarball and improve docs
Diffstat (limited to 'src/Propellor/Property/Chroot.hs')
-rw-r--r--src/Propellor/Property/Chroot.hs12
1 files changed, 7 insertions, 5 deletions
diff --git a/src/Propellor/Property/Chroot.hs b/src/Propellor/Property/Chroot.hs
index a0bbad35..d17edae7 100644
--- a/src/Propellor/Property/Chroot.hs
+++ b/src/Propellor/Property/Chroot.hs
@@ -4,6 +4,7 @@ module Propellor.Property.Chroot (
Chroot(..),
ChrootBootstrapper(..),
Debootstrapped(..),
+ ChrootTarball(..),
debootstrapped,
bootstrapped,
provisioned,
@@ -53,11 +54,12 @@ class ChrootBootstrapper b where
-- If the operating System is not supported, return Nothing.
buildchroot :: b -> System -> FilePath -> Maybe (Property HasInfo)
--- | Use to extract a tarball with a filesystem image.
+-- | Use this to bootstrap a chroot by extracting a tarball.
--
--- The filesystem image is expected to be a root directory (no top-level
--- directory, also known as a "tarbomb"). It may be optionally compressed with
--- any format `tar` knows how to detect automatically.
+-- The tarball is expected to contain a root directory (no top-level
+-- directory, also known as a "tarbomb").
+-- It may be optionally compressed with any format `tar` knows how to
+-- detect automatically.
data ChrootTarball = ChrootTarball FilePath
instance ChrootBootstrapper ChrootTarball where
@@ -76,7 +78,7 @@ extractTarball target src = toProp .
, src
]
--- | Use to bootstrap a chroot with debootstrap.
+-- | Use this to bootstrap a chroot with debootstrap.
data Debootstrapped = Debootstrapped Debootstrap.DebootstrapConfig
instance ChrootBootstrapper Debootstrapped where