Add more code documentation.

[dead/htsn.git] / src / ExitCodes.hs

diff --git a/src/ExitCodes.hs b/src/ExitCodes.hs
index b5765cc58311ed12c54d3069838e9bc3924c6f1b..4f8cd5387cb2faceb6d85f9b3668d3eb9cfd85f5 100644 (file)
--- a/src/ExitCodes.hs
+++ b/src/ExitCodes.hs
@@ -1,10 +1,10 @@
--- |All exit codes that the program can return (excepting
--- ExitSuccess). There's only one, since the program will try and fail
--- forever upon errors.
+-- | All exit codes that the program can return (excepting
+--   ExitSuccess).
 module ExitCodes (
   exit_no_feed_hosts,
   exit_no_password,
-  exit_no_username )
+  exit_no_username,
+  exit_pidfile_exists )
 where
 
 -- | No feed hosts were given on the command line or in the config file.
@@ -18,3 +18,9 @@ exit_no_password = 2
 -- | No username was given on the command line or in the config file.
 exit_no_username :: Int
 exit_no_username = 3
+
+-- | When running as a daemon, the existence of a fixed PID file is
+--   used to determine whether or not the daemon is already
+--   running. If the PID file already exists, we shouldn't start.
+exit_pidfile_exists :: Int
+exit_pidfile_exists = 4