Changes between Version 4 and Version 5 of Developer/Coding/NamingRules

Timestamp:

05/30/14 18:14:34 (10 years ago)

Author:

Gedare

Comment:

Developer/Coding/NamingRules

@@ -3 +3 @@
 = General rules =
 
- *  Avoid abbreviations.
+ *  Avoid abbreviations. Exceptions are for well-known acronyms.
+ *  Use descriptive language.
+ *  File names should be lower-case alphabet letters only, plus the extension.
+ *  Local-scope variable names are all lower case with underscores between words.
+ *  Constants are all capital letters with underscores between words.
+ *  Type names, function names, and global scope names have different rules depending on whether they are part of the public API or are internal to RTEMS, see below.
 = User-facing API =
 
-The public API routines follow a standard API like POSIX or *BSD or start with rtems_.
+The public API routines follow a standard API like POSIX or *BSD or start with rtems_. If a name starts with rtems_, then it should be assumed to be available for use by the application and be documented in the User's Guide.
+= Classic API =
 
-If a name starts with rtems_, then it should be assumed to be available for use by the application and be documented in the User's Guide.
+ *  TODO.
 = SuperCore Naming =