Removing CVS/SVN tags and replacing with git-based versioning

[nagiosplug.git] / doc / developer-guidelines.sgml

diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml
index 15920afe07c38794e25dabce12ef68e58a6f7887..ed7e422692f7c821063be0e372c3ef42b8583db7 100644 (file)
--- a/doc/developer-guidelines.sgml
+++ b/doc/developer-guidelines.sgml
@@ -16,8 +16,8 @@
        
     <revhistory>
        <revision>
-          <revnumber>$Revision$</revnumber>
-          <date>$Date$</date>
+          <revnumber>1796</revnumber>
+          <date>2007-09-24 14:51:07 -0400 (Mon, 24 Sep 2007)</date>
        </revision>
     </revhistory>
 
@@ -56,7 +56,7 @@
        <literallayout>
        gnu make 3.79
        automake 1.9.2
-       autoconf 2.58
+       autoconf 2.59
        gnu m4 1.4.2
        gnu libtool 1.5
        </literallayout>
@@ -87,11 +87,14 @@
                the entire output to appear in a pager message, which will get chopped
                off after a certain length.</para>
 
+               <para>As Nagios does not capture stderr output, you should only output to 
+               STDOUT and not print to STDERR.</para>
+
                <section><title>Print only one line of text</title>
                <para>Nagios will only grab the first line of text from STDOUT
                when it notifies contacts about potential problems. If you print
-               multiple lines, you're out of luck. Remember, keep it short and
-               to the point.</para>
+               multiple lines, you're out of luck (though this will be a feature of 
+               Nagios 3). Remember, keep your output short and to the point.</para>
 
                <para>Output should be in the format:</para>
                <literallayout>
@@ -139,8 +142,9 @@
 
                <section><title>Screen Output</title>
                <para>The plug-in should print the diagnostic and just the
-               synopsis part of the help message.  A well written plugin would
+               usage part of the help message.  A well written plugin would
                then have --help as a way to get the verbose help.</para>
+
                <para>Code and output should try to respect the 80x25 size of a
                crt (remember when fixing stuff in the server room!)</para>
                </section>
@@ -674,7 +678,7 @@ all the current tests and report an overall success rate.
 </para>
 
 <para>
-See the <ulink url="http://tinderbox.altinity.org">Nagios Plugins Tinderbox server</ulink>
+See the <ulink url="http://tinderbox.opsera.com">Nagios Plugins Tinderbox server</ulink>
 for the daily test results.
 </para>
 
@@ -731,6 +735,10 @@ setup the tests. Run "make test" to run all the tests.
 
        <para>You should use /* */ for comments and not // as some compilers
        do not handle the latter form.</para>
+
+       <para>You should also avoid using the type "bool" and its values
+       "true" and "false". Instead use the "int" type and the plugins' own
+       "TRUE"/"FALSE" values to keep the code uniformly.</para>
        </section>
 
        <section><title>Crediting sources</title>
@@ -743,23 +751,13 @@ setup the tests. Run "make test" to run all the tests.
        </section>
 
        <section><title>CVS comments</title>
-       <para>When adding CVS comments at commit time, you can use the following prefixes:
-       <variablelist>
-         <varlistentry><term>- comment</term>
-         <listitem>
-           <para>for a comment that can be removed from the Changelog</para>
-         </listitem>
-         </varlistentry>
-         <varlistentry><term>* comment</term>
-         <listitem>
-           <para>for an important amendment to be included into a features list</para>
-         </listitem>
-         </varlistentry>
-       </variablelist>
-       </para>
        <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>
        </section>
 
        <section id="translationsdevelopers"><title>Translations for developers</title>