summaryrefslogtreecommitdiff
path: root/src/Propellor/Property
diff options
context:
space:
mode:
authorJoey Hess2014-12-09 14:22:37 -0400
committerJoey Hess2014-12-09 14:22:37 -0400
commit2e2438ae66490a2a00972be16e95f0d9cda2f9ea (patch)
tree33c651ccf3d64f7c61f13f2d03d64d86a14ad225 /src/Propellor/Property
parent3c48f6ac937b88f5fa4e953f505086429f45dd58 (diff)
improve haddock formating of filenames
Diffstat (limited to 'src/Propellor/Property')
-rw-r--r--src/Propellor/Property/Apt.hs2
-rw-r--r--src/Propellor/Property/Debootstrap.hs2
-rw-r--r--src/Propellor/Property/Docker.hs4
-rw-r--r--src/Propellor/Property/Grub.hs6
-rw-r--r--src/Propellor/Property/Hostname.hs10
-rw-r--r--src/Propellor/Property/OS.hs12
-rw-r--r--src/Propellor/Property/Postfix.hs2
-rw-r--r--src/Propellor/Property/Systemd.hs2
8 files changed, 20 insertions, 20 deletions
diff --git a/src/Propellor/Property/Apt.hs b/src/Propellor/Property/Apt.hs
index 68e877ed..2dd9ca16 100644
--- a/src/Propellor/Property/Apt.hs
+++ b/src/Propellor/Property/Apt.hs
@@ -90,7 +90,7 @@ stdSourcesListFor suite = stdSourcesList' suite []
-- | Adds additional sources.list generators.
--
-- Note that if a Property needs to enable an apt source, it's better
--- to do so via a separate file in /etc/apt/sources.list.d/
+-- to do so via a separate file in </etc/apt/sources.list.d/>
stdSourcesList' :: DebianSuite -> [SourcesGenerator] -> Property
stdSourcesList' suite more = setSourcesList
(concatMap (\gen -> gen suite) generators)
diff --git a/src/Propellor/Property/Debootstrap.hs b/src/Propellor/Property/Debootstrap.hs
index 0a7308ff..300edb42 100644
--- a/src/Propellor/Property/Debootstrap.hs
+++ b/src/Propellor/Property/Debootstrap.hs
@@ -233,7 +233,7 @@ makeWrapperScript dir = do
]
modifyFileMode wrapperScript (addModes $ readModes ++ executeModes)
--- Work around for http://bugs.debian.org/770217
+-- Work around for <http://bugs.debian.org/770217>
makeDevicesTarball :: IO ()
makeDevicesTarball = do
-- TODO append to tarball; avoid writing to /dev
diff --git a/src/Propellor/Property/Docker.hs b/src/Propellor/Property/Docker.hs
index 5006ed9a..2c8af413 100644
--- a/src/Propellor/Property/Docker.hs
+++ b/src/Propellor/Property/Docker.hs
@@ -176,7 +176,7 @@ garbageCollected = propertyList "docker garbage collected"
-- | Tweaks a container to work well with docker.
--
-- Currently, this consists of making pam_loginuid lines optional in
--- the pam config, to work around https://github.com/docker/docker/issues/5663
+-- the pam config, to work around <https://github.com/docker/docker/issues/5663>
-- which affects docker 1.2.0.
tweaked :: Property
tweaked = trivial $
@@ -529,7 +529,7 @@ dockerInfo :: DockerInfo Host -> Info
dockerInfo i = mempty { _dockerinfo = i }
-- | The ContainerIdent of a container is written to
--- /.propellor-ident inside it. This can be checked to see if
+-- </.propellor-ident> inside it. This can be checked to see if
-- the container has the same ident later.
propellorIdent :: FilePath
propellorIdent = "/.propellor-ident"
diff --git a/src/Propellor/Property/Grub.hs b/src/Propellor/Property/Grub.hs
index 00592d0b..71593523 100644
--- a/src/Propellor/Property/Grub.hs
+++ b/src/Propellor/Property/Grub.hs
@@ -4,10 +4,10 @@ import Propellor
import qualified Propellor.Property.File as File
import qualified Propellor.Property.Apt as Apt
--- | Eg, hd0,0 or xen/xvda1
+-- | Eg, "hd0,0" or "xen/xvda1"
type GrubDevice = String
--- | Eg, /dev/sda
+-- | Eg, "/dev/sda"
type OSDevice = String
type TimeoutSecs = Int
@@ -51,7 +51,7 @@ boots dev = cmdProperty "grub-install" [dev]
--
-- Useful when the VPS's pv-grub is too old to boot a modern kernel image.
--
--- http://notes.pault.ag/linode-pv-grub-chainning/
+-- <http://notes.pault.ag/linode-pv-grub-chainning/>
--
-- The rootdev should be in the form "hd0", while the bootdev is in the form
-- "xen/xvda".
diff --git a/src/Propellor/Property/Hostname.hs b/src/Propellor/Property/Hostname.hs
index 4a5e77d3..f1709d4d 100644
--- a/src/Propellor/Property/Hostname.hs
+++ b/src/Propellor/Property/Hostname.hs
@@ -7,14 +7,14 @@ import Data.List
-- | Ensures that the hostname is set using best practices.
--
--- Configures `/etc/hostname` and the current hostname.
+-- Configures </etc/hostname> and the current hostname.
--
--- Configures `/etc/mailname` with the domain part of the hostname.
+-- Configures </etc/mailname> with the domain part of the hostname.
--
--- `/etc/hosts` is also configured, with an entry for 127.0.1.1, which is
+-- </etc/hosts> is also configured, with an entry for 127.0.1.1, which is
-- standard at least on Debian to set the FDQN.
--
--- Also, the `/etc/hosts` 127.0.0.1 line is set to localhost. Putting any
+-- Also, the </etc/hosts> 127.0.0.1 line is set to localhost. Putting any
-- other hostnames there is not best practices and can lead to annoying
-- messages from eg, apache.
sane :: Property
@@ -44,7 +44,7 @@ setTo hn = combineProperties desc go
(ip ++ "\t" ++ (unwords names)) : filter (not . hasip ip) ls
hasip ip l = headMaybe (words l) == Just ip
--- | Makes `/etc/resolv.conf` contain search and domain lines for
+-- | Makes </etc/resolv.conf> contain search and domain lines for
-- the domain that the hostname is in.
searchDomain :: Property
searchDomain = property desc (ensureProperty . go =<< asks hostName)
diff --git a/src/Propellor/Property/OS.hs b/src/Propellor/Property/OS.hs
index efd7a509..b60151e8 100644
--- a/src/Propellor/Property/OS.hs
+++ b/src/Propellor/Property/OS.hs
@@ -33,10 +33,10 @@ import Control.Exception (throw)
-- the property to.
--
-- This property only runs once. The cleanly installed system will have
--- a file /etc/propellor-cleaninstall, which indicates it was cleanly
+-- a file </etc/propellor-cleaninstall>, which indicates it was cleanly
-- installed.
--
--- The files from the old os will be left in /old-os
+-- The files from the old os will be left in </old-os>
--
-- After the OS is installed, and if all properties of the host have
-- been successfully satisfied, the host will be rebooted to properly load
@@ -188,13 +188,13 @@ confirmed desc (Confirmed c) = property desc $ do
return FailedChange
else return NoChange
--- | /etc/network/interfaces is configured to bring up the network
+-- | </etc/network/interfaces> is configured to bring up the network
-- interface that currently has a default route configured, using
-- the same (static) IP address.
preserveNetwork :: Property
preserveNetwork = undefined -- TODO
--- | /etc/resolv.conf is copied the from the old OS
+-- | </etc/resolv.conf> is copied from the old OS
preserveResolvConf :: Property
preserveResolvConf = check (fileExist oldloc) $
property (newloc ++ " copied from old OS") $ do
@@ -204,7 +204,7 @@ preserveResolvConf = check (fileExist oldloc) $
newloc = "/etc/resolv.conf"
oldloc = oldOSDir ++ newloc
--- | Root's .ssh/authorized_keys has added to it any ssh keys that
+-- | </root/.ssh/authorized_keys> has added to it any ssh keys that
-- were authorized in the old OS. Any other contents of the file are
-- retained.
preserveRootSshAuthorized :: Property
@@ -216,7 +216,7 @@ preserveRootSshAuthorized = check (fileExist oldloc) $
newloc = "/root/.ssh/authorized_keys"
oldloc = oldOSDir ++ newloc
--- Removes the old OS's backup from /old-os
+-- Removes the old OS's backup from </old-os>
oldOSRemoved :: Confirmation -> Property
oldOSRemoved confirmation = check (doesDirectoryExist oldOSDir) $
go `requires` confirmed "old OS backup removal confirmed" confirmation
diff --git a/src/Propellor/Property/Postfix.hs b/src/Propellor/Property/Postfix.hs
index b3d12727..7821b333 100644
--- a/src/Propellor/Property/Postfix.hs
+++ b/src/Propellor/Property/Postfix.hs
@@ -50,7 +50,7 @@ mappedFile f setup = setup f
`onChange` cmdProperty "postmap" [f]
-- | Run newaliases command, which should be done after changing
--- /etc/aliases.
+-- </etc/aliases>.
newaliases :: Property
newaliases = trivial $ cmdProperty "newaliases" []
diff --git a/src/Propellor/Property/Systemd.hs b/src/Propellor/Property/Systemd.hs
index 9cb532e0..e80c32be 100644
--- a/src/Propellor/Property/Systemd.hs
+++ b/src/Propellor/Property/Systemd.hs
@@ -227,7 +227,7 @@ containerCfg p = RevertableProperty (mk True) (mk False)
('-':_) -> p
_ -> "--" ++ p
--- | Bind mounts /etc/resolv.conf from the host into the container.
+-- | Bind mounts </etc/resolv.conf> from the host into the container.
--
-- This property is enabled by default. Revert it to disable it.
resolvConfed :: RevertableProperty