diff options
-rw-r--r-- | doc/developer-guidelines.sgml | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml index 4186ed7f..0afa733b 100644 --- a/doc/developer-guidelines.sgml +++ b/doc/developer-guidelines.sgml | |||
@@ -713,19 +713,18 @@ setup the tests. Run "make test" to run all the tests. | |||
713 | </section> | 713 | </section> |
714 | <section id="CodingGuidelines"><title>Coding guidelines</title> | 714 | <section id="CodingGuidelines"><title>Coding guidelines</title> |
715 | <para>See <ulink url="http://www.gnu.org/prep/standards_toc.html">GNU | 715 | <para>See <ulink url="http://www.gnu.org/prep/standards_toc.html">GNU |
716 | Coding standards</ulink> for general guidelines.</para> | 716 | Coding standards</ulink> for general guidelines. |
717 | Some parts of the guidelines (namely and explicitly the coding style) | ||
718 | are not seen as best practice by us.</para> | ||
717 | <section><title>C coding</title> | 719 | <section><title>C coding</title> |
718 | 720 | ||
719 | <para>Variables should be declared at the beginning of code blocks and | ||
720 | not inline because of portability with older compilers.</para> | ||
721 | |||
722 | <para>You should use the type "bool" and its values | 721 | <para>You should use the type "bool" and its values |
723 | "true" and "false" instead of the "int" type for booleans. | 722 | "true" and "false" instead of the "int" type for booleans. |
724 | </para> | 723 | </para> |
725 | </section> | 724 | </section> |
726 | 725 | ||
727 | <section><title>Crediting sources</title> | 726 | <section><title>Crediting sources</title> |
728 | <para>If you have copied a routine from another source, make sure the licence | 727 | <para>If you have copied a routine from another source, make sure the license |
729 | from your source allows this. Add a comment referencing the ACKNOWLEDGEMENTS | 728 | from your source allows this. Add a comment referencing the ACKNOWLEDGEMENTS |
730 | file, where you can put more detail about the source.</para> | 729 | file, where you can put more detail about the source.</para> |
731 | <para>For contributed code, do not add any named credits in the source code | 730 | <para>For contributed code, do not add any named credits in the source code |