Contributor’s Guidelines

• 1. DPDK Coding Style
  • 1.1. Description
  • 1.2. General Guidelines
  • 1.3. C Comment Style
  • 1.4. C Preprocessor Directives
  • 1.5. C Types
  • 1.6. C Indentation
  • 1.7. C Function Definition, Declaration and Use
  • 1.8. C Statement Style and Conventions
  • 1.9. Python Code
• 2. Design
  • 2.1. Environment or Architecture-specific Sources
  • 2.2. Library Statistics
  • 2.3. PF and VF Considerations
• 3. Managing ABI updates
  • 3.1. Description
  • 3.2. General Guidelines
  • 3.3. What is an ABI
  • 3.4. The DPDK ABI policy
  • 3.5. Examples of Deprecation Notices
  • 3.6. Versioning Macros
  • 3.7. Setting a Major ABI version
  • 3.8. Examples of ABI Macro use
  • 3.9. Running the ABI Validator
• 4. DPDK Documentation Guidelines
  • 4.1. Structure of the Documentation
  • 4.2. Role of the Documentation
  • 4.3. Building the Documentation
  • 4.4. Document Guidelines
  • 4.5. RST Guidelines
  • 4.6. Doxygen Guidelines
• 5. Contributing Code to DPDK
  • 5.1. The DPDK Development Process
  • 5.2. Maintainers and Sub-trees
  • 5.3. Getting the Source Code
  • 5.4. Make your Changes
  • 5.5. Commit Messages: Subject Line
  • 5.6. Commit Messages: Body
  • 5.7. Creating Patches
  • 5.8. Checking the Patches
  • 5.9. Checking Compilation
  • 5.10. Sending Patches
  • 5.11. The Review Process
• 6. DPDK Stable Releases and Long Term Support
  • 6.1. Introduction
  • 6.2. Stable Releases
  • 6.3. LTS Release
  • 6.4. What changes should be backported
  • 6.5. The Stable Mailing List
  • 6.6. Releasing
  • 6.7. ABI
• 7. Patch Cheatsheet