Build_Project_Management_System.md

graph LR
    Build_Orchestrator["Build Orchestrator"]
    Kit_Structure_Manager["Kit Structure Manager"]
    Core_Library_Builder["Core Library Builder"]
    Encoder_Library_Builder["Encoder Library Builder"]
    Version_Updater["Version Updater"]
    Documentation_Generator["Documentation Generator"]
    Test_Runner["Test Runner"]
    Installation_Manager["Installation Manager"]
    Build_Orchestrator -- "orchestrates" --> Kit_Structure_Manager
    Build_Orchestrator -- "orchestrates" --> Core_Library_Builder
    Build_Orchestrator -- "orchestrates" --> Encoder_Library_Builder
    Build_Orchestrator -- "orchestrates" --> Version_Updater
    Build_Orchestrator -- "orchestrates" --> Documentation_Generator
    Build_Orchestrator -- "orchestrates" --> Test_Runner
    Build_Orchestrator -- "orchestrates" --> Installation_Manager

Loading

Details

The Build & Project Management System subsystem is primarily encapsulated within the xed_mbuild.py file, serving as the central control for the XED library's entire build and project lifecycle. The subsystem's core functionality is defined by the xed_mbuild.py module, which orchestrates data ingestion, code generation, compilation, linking, and deployment for the XED library.

Build Orchestrator

The central coordinating component that manages the entire build lifecycle from start to finish. It acts as the primary delegator for all build-related tasks, including initial environment setup.

Related Classes/Methods:

• xed_mbuild.work:2856-2923
• xed_mbuild.execute:2929-2937

Kit Structure Manager

Prepares the necessary directory layout and initial file setup required for the build output and intermediate artifacts.

Related Classes/Methods:

• xed_mbuild.create_working_kit_structure:2408-2499

Core Library Builder

Responsible for compiling and linking the primary XED library, including its core source files, extensions, and necessary header generation.

Related Classes/Methods:

• xed_mbuild.build_libxed:1782-1939

Encoder Library Builder

A specialized component dedicated to building the XED encoder library, reflecting the modular and potentially separate compilation needs within a low-level library.

Related Classes/Methods:

• xed_mbuild.build_libxedenc2:1941-2015

Version Updater

Manages and applies version information to the built artifacts and source code, critical for release management and tracking in a low-level library.

Related Classes/Methods:

• xed_mbuild.update_version:2641-2644

Documentation Generator

Creates API documentation and other user-facing documentation, which is essential for library consumers to understand and utilize the XED library effectively.

Related Classes/Methods:

• xed_mbuild.make_doxygen_build:521-544
• xed_mbuild.create_doxygen_api_documentation:546-556

Test Runner

Executes various tests to ensure the correctness, stability, and performance of the built components and the overall XED library.

Related Classes/Methods:

• xed_mbuild.run_tests:2761-2776

Installation Manager

Manages the final deployment of built artifacts, including placing files in target directories and setting appropriate permissions.

Related Classes/Methods:

• xed_mbuild.system_install:2318-2363

FAQ