From 1a55d09b5452f07508d4624b632e9a54782dbee8 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Fri, 23 Oct 2015 01:27:22 -0400 Subject: export ChrootTarball and improve docs --- src/Propellor/Property/Chroot.hs | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) (limited to 'src') 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 -- cgit v1.2.3