Changes between Version 6 and Version 7 of Developer/Coding/Conventions


Ignore:
Timestamp:
Dec 15, 2012, 5:45:40 PM (7 years ago)
Author:
Gedare
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Developer/Coding/Conventions

    v6 v7  
    77Historically, the RTEMS project has not outright rejected any submission of general utility.  We have worked with the authors to ensure that the code conforms to the standards.  In many cases, the source code has been merged into the source base under the good faith assumption that concerns will be addressed.
    88
    9 As an exception, code the is merged from another source such as FreeBSD or another open source project into the RTEMS source tree will NOT be reformatted!!!  This is critical as it makes it difficult to merge future updates and bug fixes.
     9As an exception, code that is merged from another source such as FreeBSD or another open source project into the RTEMS source tree will NOT be reformatted!!!  This is critical as it makes it difficult to merge future updates and bug fixes.
    1010= Source Documentation =
    1111
     
    1414
    1515
    16  *  Every file should include a header with the copyright notice.  This is a typical example:
     16 *  Every file should include two comment header blocks, one for the Doxygen output and a copyright notice.  This is a typical example:
    1717{{{
    1818/**
    1919 * @file
    20  * @brief short "Table of Contents" description of code
     20 *
     21 * @ingroup TheGroupForThisFile
     22 *
     23 * @brief Short "Table of Contents" Description of File Contents
    2124 *
    2225 * A short description of the purpose of this file.
     
    3336}}}
    3437
     38 *  The Doxygen header block is separate from the copyright notice intentionally so the copyright notice is not included in the Doxygen output.
     39 *  The copyright owner and specific license terms may vary. The above is typical and the preferred license, but BSD, "use as is", and others are acceptable.  Pure GPL licensed code is NOT acceptable.
     40= Miscellaneous =
     41
    3542 *  Do not put unrelated functions or data in a single file.  This results in object code bloat.
    3643 *  If adding code to ''cpukit'' be sure the filename is unique since it will be merged all code under that directory gets merged into a single library.
    37  *  The Doxygen header block is separate from the copyright notice intentionally so the copyright notice is not included in the Doxygen output.
    38  *  The copyright owner and specific license terms may vary. The above is typical and the preferred license, but BSD, "use as is", and others are acceptable.  Pure GPL licensed code is NOT acceptable.
    3944= Source Code Style =
    4045