diff options
| author | Holger Weiss <holger@zedat.fu-berlin.de> | 2015-10-04 23:34:01 +0200 |
|---|---|---|
| committer | Holger Weiss <holger@zedat.fu-berlin.de> | 2015-10-04 23:42:41 +0200 |
| commit | 3f17f18416521ee90b8823bab3324188976ac265 (patch) | |
| tree | 195bd71e6cab33acfd4303545f6472f1e984217a /doc | |
| parent | 5ca1bff80cf86c290a0803f3cf37aee9bd57d41f (diff) | |
| parent | bebf1cd050ecb0e23f02353e19125767623bd41f (diff) | |
| download | monitoring-plugins-3f17f18416521ee90b8823bab3324188976ac265.tar.gz | |
Merge branch 'pr/1363'
* pr/1363:
use unknown exit code for help/version in plugins-root as well
use unknown exit code for help/version in plugins
change exit code to unknown on help and version info
use exit code 3 for version and help
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer-guidelines.sgml | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml index d9340285..228d3fa1 100644 --- a/doc/developer-guidelines.sgml +++ b/doc/developer-guidelines.sgml | |||
| @@ -194,13 +194,15 @@ | |||
| 194 | <row> | 194 | <row> |
| 195 | <entry align="center"><para>3</para></entry> | 195 | <entry align="center"><para>3</para></entry> |
| 196 | <entry valign="middle"><para>Unknown</para></entry> | 196 | <entry valign="middle"><para>Unknown</para></entry> |
| 197 | <entry><para>Invalid command line arguments were supplied to the | 197 | <entry><para>Invalid command line arguments were supplied to the |
| 198 | plugin or low-level failures internal to the plugin (such as unable to fork, | 198 | plugin or low-level failures internal to the plugin (such as unable to fork, |
| 199 | or open a tcp socket) that prevent it from performing the specified | 199 | or open a tcp socket) that prevent it from performing the specified |
| 200 | operation. Higher-level errors (such as name resolution errors, | 200 | operation. Higher-level errors (such as name resolution errors, |
| 201 | socket timeouts, etc) are outside of the control of plugins and should | 201 | socket timeouts, etc) are outside of the control of plugins and should |
| 202 | generally NOT be reported as UNKNOWN states. | 202 | generally NOT be reported as UNKNOWN states. |
| 203 | </para></entry> | 203 | </para> |
| 204 | <para>The --help or --version output should also result in Unknown state.</para> | ||
| 205 | </entry> | ||
| 204 | </row> | 206 | </row> |
| 205 | </tbody> | 207 | </tbody> |
| 206 | </tgroup> | 208 | </tgroup> |
| @@ -610,6 +612,9 @@ | |||
| 610 | <para>The option -v or --verbose should be present in all plugins. | 612 | <para>The option -v or --verbose should be present in all plugins. |
| 611 | The user should be allowed to specify -v multiple times to increase | 613 | The user should be allowed to specify -v multiple times to increase |
| 612 | the verbosity level, as described in <xref linkend="verboselevels">.</para> | 614 | the verbosity level, as described in <xref linkend="verboselevels">.</para> |
| 615 | |||
| 616 | The exit code for version information or help should be UNKNOWN | ||
| 617 | (3).</para> | ||
| 613 | </section> | 618 | </section> |
| 614 | 619 | ||
| 615 | <section> | 620 | <section> |
