aboutsummaryrefslogtreecommitdiff
path: root/Documentation/CodingGuidelines
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/CodingGuidelines')
-rw-r--r--Documentation/CodingGuidelines25
1 files changed, 25 insertions, 0 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index df72fe0177..b8670751f5 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -33,6 +33,16 @@ Git in general, a few rough rules are:
achieve and why the changes were necessary (more on this in the
accompanying SubmittingPatches document).
+ - A label "NEEDSWORK:" followed by a description of the things to
+ be done is a way to leave in-code comments to document design
+ decisions yet to be made. 80% of the work to resolve a NEEDSWORK
+ comment is to decide if it still makes sense to do so, since the
+ situation around the codebase may have changed since the comment
+ was written. It can be a very valid change to remove an existing
+ NEEDSWORK comment without doing anything else, with the commit log
+ message describing a good argument why it does not make sense to do
+ the thing the NEEDSWORK comment mentioned.
+
Make your code readable and sensible, and don't try to be clever.
As for more concrete guidelines, just imitate the existing code
@@ -430,6 +440,8 @@ For C programs:
*/
_("Here is a translatable string explained by the above.");
+ We do not use // comments.
+
- Double negation is often harder to understand than no negation
at all.
@@ -656,6 +668,19 @@ For C programs:
unsigned other_field:1;
unsigned field_with_longer_name:1;
+ - Array names should be named in the singular form if the individual items are
+ subject of use. E.g.:
+
+ char *dog[] = ...;
+ walk_dog(dog[0]);
+ walk_dog(dog[1]);
+
+ Cases where the array is employed as a whole rather than as its unit parts,
+ the plural forms is preferable. E.g:
+
+ char *dogs[] = ...;
+ walk_all_dogs(dogs);
+
For Perl programs:
- Most of the C guidelines above apply.