Code

Corrected example
[nagiosplug.git] / doc / developer-guidelines.sgml
index ed7e422692f7c821063be0e372c3ef42b8583db7..1ce78ff401b67e81bd018d62c7db044c553a9474 100644 (file)
@@ -11,7 +11,7 @@
       </author>
     </authorgroup>
 
-    <pubdate>2006</pubdate>
+    <pubdate>2009</pubdate>
     <title>Nagios plug-in development guidelines</title>
        
     <revhistory>
@@ -22,7 +22,7 @@
     </revhistory>
 
        <copyright>
-               <year>2000 - 2006</year> 
+               <year>2000 - 2009</year>
                <holder>Nagios Plugins Development Team</holder>
        </copyright>
 
@@ -34,7 +34,7 @@
     the plug-in developers and encourage the standarization of the
     different kind of plug-ins: C, shell, perl, python, etc.</para>
 
-        <para>Nagios Plug-in Development Guidelines Copyright (C) 2000-2006
+        <para>Nagios Plug-in Development Guidelines Copyright (C) 2000-2009
         (Nagios Plugins Team)</para>
 
         <para>Permission is granted to make and distribute verbatim
        <para>
        Nagios plugins are developed to the GNU standard, so any OS which is supported by GNU
        should run the plugins. While the requirements for compiling the Nagios plugins release 
-       is very small, to develop from CVS needs additional software to be installed. These are the 
-       minimum levels of software required:
+       are very basic, developing from the Git repository requires additional software to be
+       installed. These are the minimum levels of software required:
 
        <literallayout>
-       gnu make 3.79
-       automake 1.9.2
-       autoconf 2.59
-       gnu m4 1.4.2
-       gnu libtool 1.5
+       GNU make 3.79
+       GNU automake 1.9.2
+       GNU autoconf 2.59
+       GNU m4 1.4.2
+       GNU libtool 1.5
        </literallayout>
 
-       To compile from CVS, after you have checked out the code, run:
+       To compile from Git, after you have cloned the repository, run:
        <literallayout>
        tools/setup
        ./configure
        make install
        </literallayout>
        </para>
-
-       <para>Note: gettext is no longer a developer platform requirement. A lot of the files in lib/ and m4/
-       are synced with the coreutils project and we use the same levels of gettext that they
-       distribute.
-       </para>
-       <para>Note: gnu libtool, which must be at version 1.5.22 or above, has files installed into CVS, so is not 
-       a development platform requirement.
-       </para>
 </section>
 
 <section id="PlugOutput"><title>Plugin Output for Nagios</title>
                                        </row>
                                        <row>
                                                <entry>check_stuff -c10:20</entry>
-                                               <entry>Critical if "stuff" is 10 to 20</entry>
+                                               <entry>Critical if "stuff" is less than 10 or over 20</entry>
                                        </row>
                                </tbody>
                        </tgroup>
                <orderedlist>
                <listitem><para>space separated list of label/value pairs</para>
                        </listitem>
-               <listitem><para>label can contain any characters</para>
+               <listitem><para>label can contain any characters except the equals sign or single quote (')</para>
                        </listitem>
                <listitem><para>the single quotes for the label are optional. Required if 
-                       spaces, = or ' are in the label</para>
+                       spaces are in the label</para>
                        </listitem>
                <listitem><para>label length is arbitrary, but ideally the first 19 characters
                        are unique (due to a limitation in RRD). Be aware of a limitation in the
@@ -750,13 +742,13 @@ setup the tests. Run "make test" to run all the tests.
        </para>
        </section>
 
-       <section><title>CVS comments</title>
+       <section><title>Commit Messages</title>
        <para>If the change is due to a contribution, please quote the contributor's name 
        and, if applicable, add the SourceForge Tracker number. Don't forget to 
 update the THANKS.in file.</para>
         <para>If you have a change that is useful for noting in the next release, please
        update the NEWS file.</para>
-       <para>All CVS commit comments will be written to a ChangeLog at release time.
+       <para>All commits will be written to a ChangeLog at release time.
        </para>
        </section>
 
@@ -792,7 +784,7 @@ update the THANKS.in file.</para>
        <section id="Patches"><title>Patches</title>
        <para>If you have a bug patch, please supply a unified or context diff against the
        version you are using. For new features, please supply a diff against
-       the CVS HEAD version.</para>
+       the Git "master" branch.</para>
 
        <para>Patches should be submitted via 
        <ulink url="http://sourceforge.net/tracker/?group_id=29880&amp;atid=397599">SourceForge's
@@ -813,7 +805,7 @@ update the THANKS.in file.</para>
        distributed with the Nagios Plugin files are held in the contrib/ directory and are not installed
        by default. These plugins are not officially supported by the team. 
        The current policy is that these plugins should be owned and maintained by the original 
-       contributor, preferably hosted on <ulink url="http://www.nagiosexchange.org">NagiosExchange</ulink>.
+       contributor, preferably hosted on <ulink url="http://exchange.nagios.org">Nagios Exchange</ulink>.
        </para>
        <para>If patches or bugs are raised to an contributed plugin, we will start communications with the
        original contributor, but seek to remove the plugin from our distribution.
@@ -825,7 +817,7 @@ update the THANKS.in file.</para>
        <section id="Newplugins"><title>New plugins</title>
        <para>If you would like others to use your plugins, please add it to
        the official 3rd party plugin repository, 
-       <ulink url="http://www.nagiosexchange.org">NagiosExchange</ulink>.
+       <ulink url="http://exchange.nagios.org">Nagios Exchange</ulink>.
        </para>
 
        <para>We are not accepting requests for inclusion of plugins into