Developer Documentation

This directory contains the documentation specifically targeted at developers of the HPCC system.

::: tip These documents are generated from Markdown by VitePress. See VitePress Markdown for more details. :::

General documentation

• Development guide: Building the system and development guide.
• C++ style guide: Style guide for c++ code.
• ECL style guide: Style guide for ECL code.
• Wiki: GitHub wiki for HPCC-Platform
• Code Submission Guidelines: Guidelines for submitting PRs
• Code Review Guidelines: Guidelines for reviewing submissions PRs
• Building with Github Actions: How to build source using Github Actions
• Writing Developer Documentation: How to ensure your documentation works well with VitePress

Implementation details for different parts of the system

• Workunit Workflow: An explanation of workunits, and a walk-through of the steps in executing a query.
• Code Generator: Details of the internals of eclcc.
• Roxie: History and design details for roxie.
• Memory Manager: Details of the memory manager (roxiemem) used by the query engines.
• Metrics: Metrics Framework Design.

Other documentation

The ECL language is documented in the ecl language reference manual (generated as ECLLanguageReference-<version>.pdf).