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. Naming
  • 1.7. C Indentation
  • 1.8. C Function Definition, Declaration and Use
  • 1.9. C Statement Style and Conventions
  • 1.10. Dynamic Logging
  • 1.11. Python Code
  • 1.12. Integrating with the Build System
  • 1.13. Meson Coding Style
• 2. Design
  • 2.1. Environment or Architecture-specific Sources
  • 2.2. Mbuf features
  • 2.3. Runtime Information - Logging, Tracing and Telemetry
  • 2.4. Library Statistics
  • 2.5. PF and VF Considerations
• 3. ABI Policy
  • 3.1. Description
  • 3.2. General Guidelines
  • 3.3. The DPDK ABI policy
  • 3.4. New ABI versions
  • 3.5. Experimental
• 4. ABI Versioning
  • 4.1. What is a library’s soname?
  • 4.2. Major ABI versions
  • 4.3. Versioning Macros
  • 4.4. Running the ABI Validator
• 5. DPDK Documentation Guidelines
  • 5.1. Structure of the Documentation
  • 5.2. Role of the Documentation
  • 5.3. Building the Documentation
  • 5.4. Document Guidelines
  • 5.5. RST Guidelines
  • 5.6. Doxygen Guidelines
• 6. DPDK Unit Testing Guidelines
  • 6.1. Background
  • 6.2. Running a test
  • 6.3. Running test cases via Meson
  • 6.4. Adding tests to dpdk-test application
  • 6.5. Designing a test
  • 6.6. Checking code coverage
  • 6.7. Adding a suite or test case to Meson
  • 6.8. Running cryptodev tests
• 7. Adding a new library
  • 7.1. Process for approval in principle
• 8. Adding a New Driver
  • 8.1. Early Engagement with the Community
  • 8.2. Progressive Work
  • 8.3. Finalizing
  • 8.4. Splitting into Patches
  • 8.5. Additional Suggestions
  • 8.6. Dependencies
  • 8.7. Test Tools
• 9. Contributing Code to DPDK
  • 9.1. The DPDK Development Process
  • 9.2. Source License
  • 9.3. Maintainers and Sub-trees
  • 9.4. Getting the Source Code
  • 9.5. Make your Changes
  • 9.6. Commit Messages: Subject Line
  • 9.7. Commit Messages: Body
  • 9.8. Creating Patches
  • 9.9. Checking the Patches
  • 9.10. Checking Compilation
  • 9.11. Checking ABI compatibility
  • 9.12. Sending Patches
  • 9.13. The Review Process
  • 9.14. Milestones definition
• 10. Linux uAPI header files
  • 10.1. Rationale
  • 10.2. Importing or updating an uAPI header file
  • 10.3. Header inclusion into library or driver
• 11. DPDK Vulnerability Management Process
  • 11.1. Scope
  • 11.2. Finding
  • 11.3. Report
  • 11.4. Confirmation
  • 11.5. CVE Request
  • 11.6. Fix Development and Review
  • 11.7. Pre-Release Disclosure
  • 11.8. Private Disclosure
  • 11.9. Public Disclosure
  • 11.10. References
• 12. DPDK Stable Releases and Long Term Support
  • 12.1. Introduction
  • 12.2. Stable Releases
  • 12.3. LTS Release
  • 12.4. What changes should be backported
  • 12.5. The Stable Mailing List
  • 12.6. Releasing
• 13. Patch Cheatsheet