How opnsense/tools works
Main Components
a) Repository Layer:
• Core Repository (core.git)
• Ports Repository (ports.git)
• Source Repository (src.git)
• Plugins Repository (plugins.git)
• Tools Repository (current project)
b) Build System Components:
• Configuration Management (/config directory)
• Build Scripts (/build directory)
• Composite Scripts (/composite directory)
• Device-Specific Configurations (/device directory)
• Utility Scripts (/scripts directory)
c) Output Components:
• Sets Directory (for built components)
• Images Directory (for final images)
• Logs Directory (for build logs)
Component Relationships
[Input Layer]
• v
[Build System Core]
[Build Steps] [Configurations] [Device Specs]
• v
[Output Layer]
Specific Implementation Details
a) Build Process Flow:
• Main build steps: base → kernel → ports → plugins → core
• Parallel paths for different image types (dvd, serial, vga, vm)
• Signing and verification processes
b) Configuration Flow:
• How device-specific configurations modify the build process
• Relationship between build.conf and local overrides
Key Elements to Highlight
• Cross-building capabilities for different architectures
• Package management and caching system
• Set management (base, kernel, packages, etc.)
• Image generation paths
• Verification and signing processes
Notes for Implementation
• Keep the main flow clear and centered
• Related components together
• Use clear labels for all components
• Version information handling
• Both standard and custom build paths
• Hierarchical layouts
• Text annotations
• Grouping of related components