Internal Documentation

This documentation is for those who want to contribute to OpenDDS and those who are just curious!

• OpenDDS Development Guidelines
  • Repository
  • Testing
  • Dependencies
  • Text File Formatting
  • Lint Script
  • Documentation
  • C++ Standard
  • C++ Coding Style
    • Example
    • Punctuation
    • Whitespace
    • Language Usage
    • Pointers and References
    • Naming
    • Comments
    • Documenting Code for Doxygen
    • Preprocessor
      • Includes
        • Order
        • Path
        • Example
    • Initialization
    • Time
    • Logging
      • ACE Logging
      • Usage in OpenDDS
        • Logging Conditions and Priority
        • Message Content
        • Examples
  • Perl Coding Style
  • Python Coding Style
  • CMake Coding Style
• Documentation Guidelines
  • Building
    • Requirements
    • HTML
    • Dash
    • PDF
    • Strict Checks
    • Building Manually
  • RST/Sphinx Usage
    • Special Links
      • :ghfile:
      • :ghissue:
      • :ghpr:
      • :ghrelease:
      • :acetaorel:
      • :omgissue:
      • :omgspec:
    • Custom Domains
      • CMake Domain
        • .. cmake:func::
          • .. cmake:func:arg::
        • target
        • ARG
        • :cmake:func:
        • .. cmake:var::
        • :cmake:var:
        • .. cmake:prop::
        • :cmake:prop:
        • .. cmake:tgt::
        • :cmake:tgt:
      • Config Domain
        • .. cfg:sec::
        • :cfg:sec:
        • .. cfg:prop::
          • :required:
          • :default:
        • :cfg:prop:
        • .. cfg:val::
        • :cfg:val:
        • Example
  • News
    • News Fragments
      • Directives
        • news-prs
        • news-start-section and news-end-section
        • news-rank
    • Generating the News
• Unit Tests
  • The Goals of Unit Testing
  • Unit Test Organization
  • Unit Test Scope
  • Isolating Dependencies
  • Writing a New Unit Test
  • Using GTest
  • Code Coverage
  • Final Word
• GitHub Actions
  • Overview
  • Legend for GitHub Actions Build Names
    • Operating System
    • Build Configuration
    • Build Type
    • Build Options
    • Feature Mask
  • build_and_test.yml Workflow
    • Triggering the Build And Test Workflow
    • Job Types
    • .lst Files
    • Workflow Checks
    • Blocked Tests
      • Only Failing on CI
      • Failing Both CI and scoreboard
    • Test Results
    • Artifacts
      • Using Artifacts to Replicate Builds
      • Using Artifacts to View More Test Information
    • Caching
• Running Tests
  • Main Test Suite
    • Building
    • Running
      • For Unixes (Linux, macOS, BSDs, etc)
      • For Windows
    • Manual Configuration
• Bench Performance & Scalability Test Framework
  • Motivation
  • Overview
    • Worker
    • Node Controller
    • Test Controller
  • Building Bench
    • Required Features
    • Required Targets
  • Running Bench
    • Environment Variables
      • Linux/Unix
      • Windows
    • Running a Bench CI Test
    • Running Scenarios Manually
  • Configuration Files
    • Scenario Configuration Files
      • IDL Definition
      • Annotated Example
    • Worker Configuration Files
      • QoS Masking
      • Annotated Example
  • Detailed Application Descriptions
    • test_controller
      • Usage
    • node_controller
      • Usage
    • worker
      • Usage
• Release Process
  • Notes About OpenDDS Releases
    • Temporary Notes
    • File Updates
    • Versioning
  • Prior to the Release
    • Address Automated Code Analysis Results
    • Update Files in the Repo as Needed
    • Update the Modeling SDK version numbers and release notes
    • Generate the Modeling SDK Eclipse update site
    • Update the opendds.org Website
    • Check if GHA Workflows need Updating
  • Making a Release
    • Before Running the Release Script
    • Running the Release Script
      • Micro Releases
      • Doing Mock Releases with the Release Script
    • After Running the Release Script
      • Test the release package
      • Update News on Master
      • Upload Artifacts from Release Workflows
      • Remove Files Used for Release