Pacemaker Development

Working with the Pacemaker Code Base

Abstract

This document has guidelines and tips for developers interested in editing Pacemaker source code and submitting changes for inclusion in the project. Start with the FAQ; the rest is optional detail.

Table of Contents

• 1. Frequently Asked Questions
• 2. General Guidelines for All Languages
  • 2.1. Copyright
• 3. Python Coding Guidelines
  • 3.1. Python Boilerplate
  • 3.2. Python Version Compatibility
  • 3.3. Formatting Python Code
• 4. C Coding Guidelines
  • 4.1. Code Organization
  • 4.2. Pacemaker Libraries
    • 4.2.1. Public versus Internal APIs
    • 4.2.2. API Documentation
    • 4.2.3. API Header File Naming
    • 4.2.4. API Symbol Naming
  • 4.3. C Boilerplate
  • 4.4. Line Formatting
  • 4.5. Comments
  • 4.6. Variables
  • 4.7. Operators
  • 4.8. Control Statements (if, else, while, for, switch)
  • 4.9. Structures
  • 4.10. Enumerations
    • 4.10.1. Flag groups
  • 4.11. Functions
    • 4.11.1. Function Definitions
    • 4.11.2. Return Values
    • 4.11.3. Public API Functions
  • 4.12. Memory Management
  • 4.13. Logging
  • 4.14. Regular Expressions
  • 4.15. Makefiles
  • 4.16. vim Settings
• 5. Evolution of the project
  • 5.1. Foreword
  • 5.2. Ancestor: Heartbeat project
    • 5.2.1. Influence of Heartbeat on Pacemaker
  • 5.3. Notable Restructuring Steps in the Codebase
• 6. Advanced Hacking on the Project
  • 6.1. Foreword
  • 6.2. Debugging
  • 6.3. Working with mocked daemons

Index

• Index
• Search Page