summaryrefslogtreecommitdiffstats
path: root/doc/developer-guidelines.sgml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/developer-guidelines.sgml')
-rw-r--r--doc/developer-guidelines.sgml52
1 files changed, 26 insertions, 26 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml
index 666d7cc..d934028 100644
--- a/doc/developer-guidelines.sgml
+++ b/doc/developer-guidelines.sgml
@@ -1,18 +1,18 @@
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 Plugin Development Guidelines</title> 3 <title>Monitoring Plugins Development Guidelines</title>
4 4
5 <bookinfo> 5 <bookinfo>
6 <authorgroup> 6 <authorgroup>
7 <author> 7 <author>
8 <affiliation> 8 <affiliation>
9 <orgname>Nagios Plugins Development Team</orgname> 9 <orgname>Monitoring Plugins Development Team</orgname>
10 </affiliation> 10 </affiliation>
11 </author> 11 </author>
12 </authorgroup> 12 </authorgroup>
13 13
14 <pubdate>2013</pubdate> 14 <pubdate>2013</pubdate>
15 <title>Nagios Plugin Development Guidelines</title> 15 <title>Monitoring Plugins Development Guidelines</title>
16 16
17 <revhistory> 17 <revhistory>
18 <revision> 18 <revision>
@@ -23,7 +23,7 @@
23 23
24 <copyright> 24 <copyright>
25 <year>2000 - 2013</year> 25 <year>2000 - 2013</year>
26 <holder>Nagios Plugins Development Team</holder> 26 <holder>Monitoring Plugins Development Team</holder>
27 </copyright> 27 </copyright>
28 28
29</bookinfo> 29</bookinfo>
@@ -34,8 +34,8 @@
34 the plugin developers and encourage the standarization of the 34 the plugin developers and encourage the standarization of the
35 different kind of plugins: C, shell, perl, python, etc.</para> 35 different kind of plugins: C, shell, perl, python, etc.</para>
36 36
37 <para>Nagios Plugin Development Guidelines Copyright (C) 2000-2013 37 <para>Monitoring Plugins Development Guidelines Copyright (C) 2000-2013
38 (Nagios Plugins Team)</para> 38 (Monitoring Plugins Team)</para>
39 39
40 <para>Permission is granted to make and distribute verbatim 40 <para>Permission is granted to make and distribute verbatim
41 copies of this manual provided the copyright notice and this 41 copies of this manual provided the copyright notice and this
@@ -48,8 +48,8 @@
48<article> 48<article>
49<section id="DevRequirements"><title>Development platform requirements</title> 49<section id="DevRequirements"><title>Development platform requirements</title>
50 <para> 50 <para>
51 Nagios Plugins are developed to the GNU standard, so any OS which is supported by GNU 51 Monitoring Plugins are developed to the GNU standard, so any OS which is supported by GNU
52 should run the plugins. While the requirements for compiling the Nagios Plugins release 52 should run the plugins. While the requirements for compiling the Monitoring Plugins release
53 are very basic, developing from the Git repository requires additional software to be 53 are very basic, developing from the Git repository requires additional software to be
54 installed. These are the minimum levels of software required: 54 installed. These are the minimum levels of software required:
55 55
@@ -152,7 +152,7 @@
152 <section><title>Plugin Return Codes</title> 152 <section><title>Plugin Return Codes</title>
153 <para>The return codes below are based on the POSIX spec of returning 153 <para>The return codes below are based on the POSIX spec of returning
154 a positive value. Netsaint prior to v0.0.7 supported non-POSIX 154 a positive value. Netsaint prior to v0.0.7 supported non-POSIX
155 compliant return code of "-1" for unknown. Nagios supports POSIX return 155 compliant return code of "-1" for unknown. Nagios supports POSIX return
156 codes by default.</para> 156 codes by default.</para>
157 157
158 <para>Note: Some plugins will on occasion print on STDOUT that an error 158 <para>Note: Some plugins will on occasion print on STDOUT that an error
@@ -379,7 +379,7 @@
379 </listitem> 379 </listitem>
380 </orderedlist> 380 </orderedlist>
381 381
382 <para>It is up to third party programs to convert the Nagios Plugins 382 <para>It is up to third party programs to convert the Monitoring Plugins
383 performance data into graphs.</para> 383 performance data into graphs.</para>
384 </section> 384 </section>
385 385
@@ -715,7 +715,7 @@ properly on non-FreeBSD systems. Install with 'CPPFLAGS="-UHAVE_LIBPTHREAD" ./co
715</para> 715</para>
716 716
717<para> 717<para>
718When you run Nagios Plugins' configure, it will look for the tap library and will automatically 718When you run Monitoring Plugins' configure, it will look for the tap library and will automatically
719setup the tests. Run "make test" to run all the tests. 719setup the tests. Run "make test" to run all the tests.
720</para> 720</para>
721</section> 721</section>
@@ -747,9 +747,9 @@ setup the tests. Run "make test" to run all the tests.
747 </section> 747 </section>
748 748
749 <section><title>Commit Messages</title> 749 <section><title>Commit Messages</title>
750 <para>If the change is due to a contribution, please quote the contributor's name 750 <para>If the change is due to a contribution, please quote the contributor's name
751 and, if applicable, add the SourceForge Tracker number. Don't forget to 751 and, if applicable, add the GitHub Issue Tracker number. Don't forget to
752update the THANKS.in file.</para> 752 update the THANKS.in file.</para>
753 <para>If you have a change that is useful for noting in the next release, please 753 <para>If you have a change that is useful for noting in the next release, please
754 update the NEWS file.</para> 754 update the NEWS file.</para>
755 <para>All commits will be written to a ChangeLog at release time. 755 <para>All commits will be written to a ChangeLog at release time.
@@ -760,7 +760,7 @@ update the THANKS.in file.</para>
760 <para>To make the job easier for translators, please follow these guidelines:</para> 760 <para>To make the job easier for translators, please follow these guidelines:</para>
761 <orderedlist> 761 <orderedlist>
762 <listitem><para> 762 <listitem><para>
763 Before creating new strings, check the po/nagios-plugins.pot file to 763 Before creating new strings, check the po/monitoring-plugins.pot file to
764 see if a similar string 764 see if a similar string
765 already exists 765 already exists
766 </para></listitem> 766 </para></listitem>
@@ -790,15 +790,15 @@ update the THANKS.in file.</para>
790 version you are using. For new features, please supply a diff against 790 version you are using. For new features, please supply a diff against
791 the Git "master" branch.</para> 791 the Git "master" branch.</para>
792 792
793 <para>Patches should be submitted via 793 <para>Patches should be submitted via
794 <ulink url="http://sourceforge.net/tracker/?group_id=29880&amp;atid=397599">SourceForge's 794 <ulink url="https://github.com/monitoring-plugins/monitoring-plugins/pulls">GitHub's
795 tracker system for Nagiosplug patches</ulink> 795 Pull requests for Monitoring Plugins</ulink>
796 and be announced to the nagiosplug-devel mailing list.</para> 796 </para>
797 797
798 <para>Submission of a patch implies that the submmitter acknowledges that they 798 <para>Submission of a patch implies that the submmitter acknowledges that they
799 are the author of the code (or have permission from the author to release the code) 799 are the author of the code (or have permission from the author to release the code)
800 and agree that the code can be released under the GPL. The copyright for the changes will 800 and agree that the code can be released under the GPL. The copyright for the changes will
801 then revert to the Nagios Plugin Development Team - this is required so that any copyright 801 then revert to the Monitoring Plugins Development Team - this is required so that any copyright
802 infringements can be investigated quickly without contacting a huge list of copyright holders. 802 infringements can be investigated quickly without contacting a huge list of copyright holders.
803 Credit will always be given for any patches through a THANKS file in the distribution.</para> 803 Credit will always be given for any patches through a THANKS file in the distribution.</para>
804 </section> 804 </section>
@@ -806,22 +806,22 @@ update the THANKS.in file.</para>
806 806
807 <section id="Contributedplugins"><title>Contributed plugins</title> 807 <section id="Contributedplugins"><title>Contributed plugins</title>
808 <para>Plugins that have been contributed to the project and 808 <para>Plugins that have been contributed to the project and
809 distributed with the Nagios Plugin files are held in the contrib/ directory and are not installed 809 distributed with the Monitoring Plugins files are held in the contrib/ directory and are not installed
810 by default. These plugins are not officially supported by the team. 810 by default. These plugins are not officially supported by the team.
811 The current policy is that these plugins should be owned and maintained by the original 811 The current policy is that these plugins should be owned and maintained by the original
812 contributor, preferably hosted on <ulink url="http://exchange.nagios.org">Nagios Exchange</ulink>. 812 contributor, preferably hosted on <ulink url="http://monitoringexchange.org">Monitoring Exchange</ulink>.
813 </para> 813 </para>
814 <para>If patches or bugs are raised to an contributed plugin, we will start communications with the 814 <para>If patches or bugs are raised to an contributed plugin, we will start communications with the
815 original contributor, but seek to remove the plugin from our distribution. 815 original contributor, but seek to remove the plugin from our distribution.
816 </para> 816 </para>
817 <para>The aim is to distribute only code that the Nagios Plugin team are responsible for. 817 <para>The aim is to distribute only code that the Monitoring Plugins team are responsible for.
818 </para> 818 </para>
819 </section> 819 </section>
820 820
821 <section id="Newplugins"><title>New plugins</title> 821 <section id="Newplugins"><title>New plugins</title>
822 <para>If you would like others to use your plugins, please add it to 822 <para>If you would like others to use your plugins, please add it to
823 the official 3rd party plugin repository, 823 the official 3rd party plugin repository,
824 <ulink url="http://exchange.nagios.org">Nagios Exchange</ulink>. 824 <ulink url="http://monitoringexchange.org">Monitoring Exchange</ulink>.
825 </para> 825 </para>
826 826
827 <para>We are not accepting requests for inclusion of plugins into 827 <para>We are not accepting requests for inclusion of plugins into
@@ -832,7 +832,7 @@ update the THANKS.in file.</para>
832 <orderedlist> 832 <orderedlist>
833 <listitem> 833 <listitem>
834 <para>Include copyright and license information in all files. Copyright must be solely 834 <para>Include copyright and license information in all files. Copyright must be solely
835 granted to the Nagios Plugin Development Team</para> 835 granted to the Monitoring Plugins Development Team</para>
836 </listitem> 836 </listitem>
837 <listitem> 837 <listitem>
838 <para>The standard command options are supported (--help, --version, 838 <para>The standard command options are supported (--help, --version,