6.3. Coding Standards#

TBD - Write introduction, re-order, identify missing content

• 6.3.1. Coding Conventions
  • 6.3.1.1. Coding Style
  • 6.3.1.2. Source Documentation
  • 6.3.1.3. Licenses
  • 6.3.1.4. Third-Party Source Code
  • 6.3.1.5. Language and Compiler
    • Compile-Time Conditional Code Features
  • 6.3.1.6. Readability
  • 6.3.1.7. Robustness
  • 6.3.1.8. Portability
  • 6.3.1.9. Maintainability
  • 6.3.1.10. Performance
  • 6.3.1.11. Miscellaneous
  • 6.3.1.12. Header Files
  • 6.3.1.13. Layering
  • 6.3.1.14. Tools
• 6.3.2. Code Formatting
  • 6.3.2.1. Rules
  • 6.3.2.2. Eighty Character Line Limit
  • 6.3.2.3. Breaking Long Lines
• 6.3.3. Deprectating Interfaces
  • 6.3.3.1. Use the deprecate attribute
  • 6.3.3.2. Add a warning
  • 6.3.3.3. Update documentation
  • 6.3.3.4. Update support code
  • 6.3.3.5. Disable deprecated warnings
  • 6.3.3.6. Add a release note
• 6.3.4. Doxygen Guidelines
  • 6.3.4.1. Group Names
  • 6.3.4.2. Use Groups
  • 6.3.4.3. Files
  • 6.3.4.4. Type Definitions
  • 6.3.4.5. Function Declarations
  • 6.3.4.6. Header File Examples
• 6.3.5. File Templates
  • 6.3.5.1. Copyright and License Block
  • 6.3.5.2. C/C++ Header File Template
  • 6.3.5.3. C/C++/Assembler Source File Template
  • 6.3.5.4. Python File Template
  • 6.3.5.5. Shell Scripts
  • 6.3.5.6. reStructuredText File Template
• 6.3.6. Naming Rules
  • 6.3.6.1. General Rules
  • 6.3.6.2. User-facing API
  • 6.3.6.3. RTEMS internal interfaces