diff options
| -rw-r--r-- | doc/developer-guidelines.sgml | 18 |
1 files changed, 13 insertions, 5 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml index d336ff1..e6a864d 100644 --- a/doc/developer-guidelines.sgml +++ b/doc/developer-guidelines.sgml | |||
| @@ -497,15 +497,23 @@ | |||
| 497 | Coding standards</ulink> for general guidelines.</para> | 497 | Coding standards</ulink> for general guidelines.</para> |
| 498 | <section><title>Comments</title> | 498 | <section><title>Comments</title> |
| 499 | <para>You should use /* */ for comments and not // as some compilers | 499 | <para>You should use /* */ for comments and not // as some compilers |
| 500 | do not handle the latter form</para> | 500 | do not handle the latter form.</para> |
| 501 | </section> | 501 | </section> |
| 502 | 502 | ||
| 503 | <section><title>CVS comments</title> | 503 | <section><title>CVS comments</title> |
| 504 | <para>When adding CVS comments at commit time, you can use the following prefixes: | 504 | <para>When adding CVS comments at commit time, you can use the following prefixes: |
| 505 | <unorderedlist> | 505 | <variablelist> |
| 506 | <listitem>"-" for a comment that can be removed from the Changelog</listitem> | 506 | <varlistentry><term>- comment</term> |
| 507 | <listitem>"*" for an important amendment to be included into a features list | 507 | <listitem> |
| 508 | </unorderedlist> | 508 | <para>for a comment that can be removed from the Changelog</para> |
| 509 | </listitem> | ||
| 510 | </varlistentry> | ||
| 511 | <varlistentry><term>* comment</term> | ||
| 512 | <listitem> | ||
| 513 | <para>for an important amendment to be included into a features list</para> | ||
| 514 | </listitem> | ||
| 515 | </varlistentry> | ||
| 516 | </variablelist> | ||
| 509 | </para> | 517 | </para> |
| 510 | </section> | 518 | </section> |
| 511 | </section> | 519 | </section> |