path: root/src/Propellor/Property
diff options
authorJoey Hess2019-11-13 10:41:03 -0400
committerJoey Hess2019-11-13 10:43:06 -0400
commit89daa9b2e904e3fc6a95b05b792aa9b3d7fca76a (patch)
tree5e7312b37530909f389e439103026b24472c4d1d /src/Propellor/Property
parent64cea570e4e82edec6016cbcb1463b3891b094e3 (diff)
improve haddocks
particularly, remove @conf@ reference as that variable name is not visible in the haddock docs unless source is viewed. Also tightened up the language and linkified more, and fixed a typo in the name of Debootstrapped.
Diffstat (limited to 'src/Propellor/Property')
1 files changed, 7 insertions, 7 deletions
diff --git a/src/Propellor/Property/Chroot.hs b/src/Propellor/Property/Chroot.hs
index df5307e4..13511902 100644
--- a/src/Propellor/Property/Chroot.hs
+++ b/src/Propellor/Property/Chroot.hs
@@ -126,10 +126,10 @@ instance ChrootBootstrapper Debootstrapped where
-- add a property such as `osDebian` to specify the operating system
-- to bootstrap.
--- If @conf@ does not include a 'DebootstrapProxy' entry, and the Chroot has a
--- defined 'Apt.proxy', then the Chroot's apt proxy will be used by debootstrap
--- in creating the Chroot, too. Similarly if the @conf@ does not include a
--- 'DebootstrapMirror' and the Chroot has a defined 'Apt.mirror'.
+-- If the 'Debootstrap.DebootstrapConfig' does not include a
+-- 'Debootstrap.DebootstrapMirror',
+-- any 'Apt.mirror' property of the chroot will configure debootstrap.
+-- Same for 'Debootstrap.DebootstrapProxy' and 'Apt.proxy'.
-- > debootstrapped Debootstrap.BuildD "/srv/chroot/ghc-dev" $ props
-- > & osDebian Unstable X86_64
@@ -141,9 +141,9 @@ debootstrapped conf = bootstrapped (Debootstrapped conf)
-- | Defines a Chroot at the given location, bootstrapped with the
-- specified ChrootBootstrapper.
--- Like 'Chroot.debootstrapped', if the ChrootBootstrapper is Debootstrap, this
--- property respects the Chroot's configured Apt.proxy and Apt.mirror, if either
--- exists.
+-- Like 'Chroot.debootstrapped', if the 'ChrootBootstrapper' is
+-- 'Debootstrapped', this property respects the Chroot's
+-- 'Apt.proxy' and 'Apt.mirror' properties.
bootstrapped :: ChrootBootstrapper b => b -> FilePath -> Props metatypes -> Chroot
bootstrapped bootstrapper location ps = c