summaryrefslogtreecommitdiff
path: root/sd_daemon/watchdog.go
diff options
context:
space:
mode:
authorLuke Shumaker <lukeshu@sbcglobal.net>2016-12-19 13:45:53 -0500
committerLuke Shumaker <lukeshu@sbcglobal.net>2016-12-19 13:45:53 -0500
commita04b84778871d77e539a675acbff05f7220e2f5e (patch)
tree4b6c54cdf6d6d5b3c3ef084f604615b2dc2b9c47 /sd_daemon/watchdog.go
parent4a3a5525172afd69bc674a2a344065cd9e9a5888 (diff)
Improve documentation.
Diffstat (limited to 'sd_daemon/watchdog.go')
-rw-r--r--sd_daemon/watchdog.go11
1 files changed, 5 insertions, 6 deletions
diff --git a/sd_daemon/watchdog.go b/sd_daemon/watchdog.go
index b32f470..be96970 100644
--- a/sd_daemon/watchdog.go
+++ b/sd_daemon/watchdog.go
@@ -31,12 +31,11 @@ import (
// WATCHDOG_USEC and WATCHDOG_PID, which will cause further calls to
// this function to fail.
//
-// If an error is returned, then the duration is 0. If the service
-// manager is not expecting a keep-alive notification from this
-// process (or if this has already been called with unsetEnv=true),
-// then ErrDisabled is returned. If there is an error parsing the
-// service manager's watchdog request, then an appropriate other error
-// is returned.
+// If an error is not returned, then the duration returned is greater
+// than 0; if an error is returned, then the duration is 0. If the
+// service manager is not expecting a keep-alive notification from
+// this process (or if this has already been called with
+// unsetEnv=true), then the error is ErrDisabled.
func WatchdogEnabled(unsetEnv bool) (time.Duration, error) {
if unsetEnv {
defer func() {