summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--doc/developer-guidelines.sgml39
1 files changed, 23 insertions, 16 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml
index 718bd02a..6e721926 100644
--- a/doc/developer-guidelines.sgml
+++ b/doc/developer-guidelines.sgml
@@ -1,4 +1,4 @@
1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> 1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" >
2<book> 2<book>
3 <title>Nagios Plug-in Developer Guidelines</title> 3 <title>Nagios Plug-in Developer Guidelines</title>
4 4
@@ -149,19 +149,19 @@
149 </thead> 149 </thead>
150 <tbody> 150 <tbody>
151 <row> 151 <row>
152 <entry align=center><para>0</para></entry> 152 <entry align="center"><para>0</para></entry>
153 <entry><para>Single line, minimal output. Summary</para></entry> 153 <entry><para>Single line, minimal output. Summary</para></entry>
154 </row> 154 </row>
155 <row> 155 <row>
156 <entry align=center><para>1</para></entry> 156 <entry align="center"><para>1</para></entry>
157 <entry><para>Single line, additional information (eg list processes that fail)</para></entry> 157 <entry><para>Single line, additional information (eg list processes that fail)</para></entry>
158 </row> 158 </row>
159 <row> 159 <row>
160 <entry align=center><para>2</para></entry> 160 <entry align="center"><para>2</para></entry>
161 <entry><para>Multi line, configuration debug output (eg ps command used)</para></entry> 161 <entry><para>Multi line, configuration debug output (eg ps command used)</para></entry>
162 </row> 162 </row>
163 <row> 163 <row>
164 <entry align=center><para>3</para></entry> 164 <entry align="center"><para>3</para></entry>
165 <entry><para>Lots of detail for plugin problem diagnosis</para></entry> 165 <entry><para>Lots of detail for plugin problem diagnosis</para></entry>
166 </row> 166 </row>
167 </tbody> 167 </tbody>
@@ -209,27 +209,27 @@
209 </thead> 209 </thead>
210 <tbody> 210 <tbody>
211 <row> 211 <row>
212 <entry align=center><para>0</para></entry> 212 <entry align="center"><para>0</para></entry>
213 <entry valign=middle><para>OK</para></entry> 213 <entry valign="middle"><para>OK</para></entry>
214 <entry><para>The plugin was able to check the service and it 214 <entry><para>The plugin was able to check the service and it
215 appeared to be functioning properly</para></entry> 215 appeared to be functioning properly</para></entry>
216 </row> 216 </row>
217 <row> 217 <row>
218 <entry align=center><para>1</para></entry> 218 <entry align="center"><para>1</para></entry>
219 <entry valign=middle><para>Warning</para></entry> 219 <entry valign="middle"><para>Warning</para></entry>
220 <entry><para>The plugin was able to check the service, but it 220 <entry><para>The plugin was able to check the service, but it
221 appeared to be above some "warning" threshold or did not appear 221 appeared to be above some "warning" threshold or did not appear
222 to be working properly</para></entry> 222 to be working properly</para></entry>
223 </row> 223 </row>
224 <row> 224 <row>
225 <entry align=center><para>2</para></entry> 225 <entry align="center"><para>2</para></entry>
226 <entry valign=middle><para>Critical</para></entry> 226 <entry valign="middle"><para>Critical</para></entry>
227 <entry><para>The plugin detected that either the service was not 227 <entry><para>The plugin detected that either the service was not
228 running or it was above some "critical" threshold</para></entry> 228 running or it was above some "critical" threshold</para></entry>
229 </row> 229 </row>
230 <row> 230 <row>
231 <entry align=center><para>3</para></entry> 231 <entry align="center"><para>3</para></entry>
232 <entry valign=middle><para>Unknown</para></entry> 232 <entry valign="middle"><para>Unknown</para></entry>
233 <entry><para>Invalid command line arguments were supplied to the 233 <entry><para>Invalid command line arguments were supplied to the
234 plugin or the plugin was unable to check the status of the given 234 plugin or the plugin was unable to check the status of the given
235 hosts/service</para></entry> 235 hosts/service</para></entry>
@@ -254,7 +254,7 @@
254 254
255 <para>Notes:</para> 255 <para>Notes:</para>
256 <orderedlist> 256 <orderedlist>
257 <listitem><para>start < end</para> 257 <listitem><para>start &gt; end></para>
258 </listitem> 258 </listitem>
259 <listitem><para>start and ":" is not required if start=0</para> 259 <listitem><para>start and ":" is not required if start=0</para>
260 </listitem> 260 </listitem>
@@ -421,7 +421,7 @@
421 variable values will still be in effect.</para> 421 variable values will still be in effect.</para>
422 </listitem> 422 </listitem>
423 423
424 <listitem><para>Do not use < DATA > (these simply do not compile under ePN).</para> 424 <listitem><para>Do not use &gt; DATA &lt; (these simply do not compile under ePN).</para>
425 </listitem> 425 </listitem>
426 426
427 <listitem><para>Do not use named subroutines</para> 427 <listitem><para>Do not use named subroutines</para>
@@ -429,7 +429,7 @@
429 429
430 <listitem><para>If writing to a file (perhaps recording 430 <listitem><para>If writing to a file (perhaps recording
431 performance data) explicitly close close it. The plugin never 431 performance data) explicitly close close it. The plugin never
432 calls <emphasis role=strong>exit</emphasis>; that is caught by 432 calls <emphasis role="strong">exit</emphasis>; that is caught by
433 p1.pl, so output streams are never closed.</para> 433 p1.pl, so output streams are never closed.</para>
434 </listitem> 434 </listitem>
435 435
@@ -649,6 +649,13 @@ update the AUTHORS file.</para>
649 <ulink url="http://sourceforge.net/tracker/?group_id=29880&amp;atid=397599">SourceForge's 649 <ulink url="http://sourceforge.net/tracker/?group_id=29880&amp;atid=397599">SourceForge's
650 tracker system for Nagiosplug patches</ulink> 650 tracker system for Nagiosplug patches</ulink>
651 and be announced to the nagiosplug-devel mailing list.</para> 651 and be announced to the nagiosplug-devel mailing list.</para>
652
653 <para>Submission of a patch implies that the submmitter acknowledges that they
654 are the author of the code (or have permission from the author to release the code)
655 and agree that the code can be released under the GPL. The copyright for the changes will
656 then revert to the Nagios Plugin Development Team - this is required so that any copyright
657 infringements can be investigated quickly without contacting a huge list of copyright holders.
658 Credit will always be given for any patches through a THANKS file in the distribution.</para>
652 </section> 659 </section>
653 660
654 <section id="New_plugins"><title>New plugins</title> 661 <section id="New_plugins"><title>New plugins</title>