Build System

Zephyr Build System

Efficiently manage the complex build and configuration stack of Zephyr RTOS.

Core Workflows

1. West Workspace & Manifests

Manage multi-repo projects and dependency allow-lists.

• Reference: west.md
• Key Tools: west init, west update, west manifest --resolve, name-allowlist.

2. Kconfig Configuration

Tune software features and hardware parameters.

• Reference: kconfig.md
• Key Tools: west build -t menuconfig, symbol searching (/), help (?).

3. Sysbuild & Multi-Image

Configure complex projects like MCUboot + Application.

• Reference: cmake.md
• Key Tools: west build --sysbuild, sysbuild.conf.

4. CMake & Project Structure

Core build logic for applications and modules.

• Reference: cmake.md
• Key Tools: CMakeLists.txt, zephyr_library(), target_sources().

Quick Start (Workspace + Build)

west init -m <manifest-repo-url> zephyr-workspace
cd zephyr-workspace
west update
west build -b native_sim samples/hello_world

Validation Checklist

• west update resolves all manifest projects without errors.
• west build succeeds for at least one known target board.
• Required Kconfig symbols are present in build/zephyr/.config.
• scripts/find_modules.sh reports module names that match the current manifest allow-list.

Automation Tools

• find_modules.sh: Scan your build/ directory to automatically identify which modules you should add to your manifest's name-allowlist.

Examples & Templates

• west_manifest_template.yml: Minimal starter manifest for west workspaces.

Resources

• References:
  • west.md: West commands, manifests, and allow-lists.
  • kconfig.md: Project configuration and menuconfig usage.
  • cmake.md: Sysbuild and CMake API integration.
• Scripts:
  • find_modules.sh: Automated allow-list discovery utility.
• Assets:
  • west_manifest_template.yml: Base west manifest template.