[run-checks] enhance document

mackerelio · Jan 12, 2019 · 2cb854d · 2cb854d
1 parent 8479c53
commit 2cb854d
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/checker/checker.go b/checker/checker.go
@@ -18,6 +18,8 @@ var Command = cli.Command{
 	Description: `
     Execute command of check plugins in mackerel-agent.conf all at once.
     It is used for checking setting and operation of the check plugins.
+	The result is output to stdout in TAP format. If any check fails,
+	it exits non-zero.
 `,
 	Action: doRunChecks,
 }