aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar Ton Voon <tonvoon@users.sourceforge.net> 2003-07-11 22:20:48 +0000
committerGravatar Ton Voon <tonvoon@users.sourceforge.net> 2003-07-11 22:20:48 +0000
commitba470d86625ed9eea28c7197e69055da744da345 (patch)
tree16914aac44b27f60f3c63a77ddf31af49433b8fc /doc
parent17827c86e1fc5f3d72ebb8548737b6e1c1ec4108 (diff)
downloadmonitoring-plugins-ba470d86625ed9eea28c7197e69055da744da345.tar.gz
- Fixed CVS commit comments
git-svn-id: https://nagiosplug.svn.sourceforge.net/svnroot/nagiosplug/nagiosplug/trunk@591 f882894a-f735-0410-b71e-b25c423dba1c
Diffstat (limited to 'doc')
-rw-r--r--doc/developer-guidelines.sgml18
1 files changed, 13 insertions, 5 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml
index d336ff13..e6a864d1 100644
--- a/doc/developer-guidelines.sgml
+++ b/doc/developer-guidelines.sgml
@@ -497,15 +497,23 @@
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>