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


Ignore:
Timestamp:
May 30, 2014, 6:14:34 PM (5 years ago)
Author:
Gedare
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Developer/Coding/NamingRules

    v4 v5  
    33= General rules =
    44
    5  *  Avoid abbreviations.
     5 *  Avoid abbreviations. Exceptions are for well-known acronyms.
     6 *  Use descriptive language.
     7 *  File names should be lower-case alphabet letters only, plus the extension.
     8 *  Local-scope variable names are all lower case with underscores between words.
     9 *  Constants are all capital letters with underscores between words.
     10 *  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.
    611= User-facing API =
    712
    8 The public API routines follow a standard API like POSIX or *BSD or start with rtems_.
     13The 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.
     14= Classic API =
    915
    10 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.
     16 *  TODO.
    1117= SuperCore Naming =
    1218