Added dev platform requirements

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

diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml
index d336ff13a5ed7ceee0f7d5e2fa8f30be07d64923..7ca9f96fde8f58e018c6ee6f4f8591a4cc6aae1b 100644 (file)
--- a/doc/developer-guidelines.sgml
+++ b/doc/developer-guidelines.sgml
@@ -70,16 +70,11 @@
 </bookinfo>
 
 
-  <preface id=preface>
-    <title>About the guidelines</title>
-
+<preface id="preface"><title>Preface</title>
     <para>The purpose of this guidelines is to provide a reference for
     the plug-in developers and encourage the standarization of the
     different kind of plug-ins: C, shell, perl, python, etc.</para>
 
-
-    <section> <title>Copyright</title>
-
         <para>Nagios Plug-in Development Guidelines Copyright (C) 2000 2001
                2002
         Karl DeBisschop, Ethan Galstad, Hugo Gayosso, Stanley Hopcroft, 
@@ -89,13 +84,34 @@
         copies of this manual provided the copyright notice and this
         permission notice are preserved on all copies.</para>
 
-               <para>The plugins themselves are copyrighted by their respective
-               authors.</para>
-
-    </section>
+       <para>The plugins themselves are copyrighted by their respective
+       authors.</para>
 </preface>
 
 <article>
+<section id="DevRequirements"><title>Development platform requirements</title>
+       <para>
+       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:
+
+       <literallayout>
+       gnu make 3.79
+       automake 1.6
+       autoconf 2.52
+       gettext 0.11.5
+       </literallayout>
+
+       To compile from CVS, after you have checked out the code, run:
+       <literallayout>
+       tools/setup
+       ./configure
+       make
+       make install
+       </literallayout>
+       </para>
+</section>
+
 <section id="PlugOutput"><title>Plugin Output for Nagios</title>
        
                <para>You should always print something to STDOUT that tells if the 
@@ -497,21 +513,41 @@
        Coding standards</ulink> for general guidelines.</para>
        <section><title>Comments</title>
        <para>You should use /* */ for comments and not // as some compilers
-       do not handle the latter form</para>
+       do not handle the latter form.</para>
        </section>
 
        <section><title>CVS comments</title>
        <para>When adding CVS comments at commit time, you can use the following prefixes:
-       <unorderedlist>
-         <listitem>"-" for a comment that can be removed from the Changelog</listitem>
-         <listitem>"*" for an important amendment to be included into a features list
-       </unorderedlist>
+       <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>
        </section>
 </section>
 
-<section id="SubmittingChanges"><title>New submissions and patches</title>
+<section id="SubmittingChanges"><title>Submission of new plugins and patches</title>
+
+       <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>
+
+       <para>Patches should be submitted via 
+       <ulink url="http://sourceforge.net/tracker/?group_id=29880&amp;atid=397599">SourceForge's
+       tracker system for Nagiosplug patches</ulink> 
+       and be announced to the nagiosplug-devel mailing list.</para>
+       </section>
 
+       <section id="New_plugins"><title>New plugins</title>
        <para>If you would like others to use your plugins and have it included in
        the standard distribution, please include patches for the relevant
        configuration files, in particular "configure.in". Otherwise submitted 
@@ -542,8 +578,10 @@ utils (perl or c or sh) rather than cooking it's own</para>
        </listitem>
       </orderedlist>
 
-       <para>Patches should be submitted via the SourceForge and be announced to
-       the mailing list.</para>
+       <para>New plugins should be submitted via 
+       <ulink url="http://sourceforge.net/tracker/?group_id=29880&amp;atid=541465">SourceForge's
+       tracker system for Nagiosplug new plugins</ulink> 
+       and be announced to the nagiosplug-devel mailing list.</para>
        
        <para>For new plugins, provide a diff to add to the EXTRAS list (configure.in) 
        unless you are fairly sure that the plugin will work for all platforms with 
@@ -551,8 +589,10 @@ utils (perl or c or sh) rather than cooking it's own</para>
 
        <para>If possible please submit a test harness. Documentation on sample
        tests coming soon.</para>
+       </section>
 
 </section>
+
 </article>
   
 </book>