From: Ton Voon <tonvoon@users.sourceforge.net>
Date: Fri, 11 Jul 2003 13:06:01 +0000 (+0000)
Subject: Added in practice of prefixing comments in CVS commits
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=17827c86e1fc5f3d72ebb8548737b6e1c1ec4108;p=nagiosplug.git

Added in practice of prefixing comments in CVS commits


git-svn-id: https://nagiosplug.svn.sourceforge.net/svnroot/nagiosplug/nagiosplug/trunk@590 f882894a-f735-0410-b71e-b25c423dba1c
---

diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml
index 3edca6b..d336ff1 100644
--- a/doc/developer-guidelines.sgml
+++ b/doc/developer-guidelines.sgml
@@ -499,6 +499,15 @@
 	<para>You should use /* */ for comments and not // as some compilers
 	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>
+	</para>
+	</section>
 </section>
 
 <section id="SubmittingChanges"><title>New submissions and patches</title>