Skip to content

docs: toolchains: point Clang instructions to Liam's fork README - #537

Merged
lgirdwood merged 1 commit into
thesofproject:masterfrom
lgirdwood:topic/clang-instructions-fork-readme
Sep 21, 2026
Merged

lgirdwood merged 1 commit into
thesofproject:masterfrom
lgirdwood:topic/clang-instructions-fork-readme

Conversation

@lgirdwood

Copy link
Copy Markdown
Member

Summary

Aligns LLVM/Clang toolchain documentation across getting_started/index.rst, developer_guides/tech/cmake.rst, and developer_guides/firmware/module_integration_guide.rst to point directly to Liam Girdwood's llvm-project fork repository and its authoritative README.md.

Key Changes

  • Getting Started Guide (getting_started/index.rst): Replaced redundant inlined compiler build and workspace clone instructions with a direct pointer to https://github.com/lgirdwood/llvm-project (branch llvm-stable) and its README.md as the authoritative Single Source of Truth for compiler setup, Windowed ABI compiler-rt builtins, and workspace branches.
  • CMake Guide (developer_guides/tech/cmake.rst): Removed erroneous environment variables (ZEPHYR_TOOLCHAIN_VARIANT=llvm, LLVM_TOOLCHAIN_PATH) and manual west build ... app/ snippets. Documented that Clang builds are invoked via xtensa-build-zephyr.py --llvm-clang and referenced the fork README. Retained the mandatory Integrated Assembler (IAS) policy.
  • Module Integration Guide (developer_guides/firmware/module_integration_guide.rst): Updated the toolchain comparison table build command to use xtensa-build-zephyr.py -p ptl --llvm-clang /path/to/llvm-project/build --build-dir-suffix -llvm and linked to the fork README.
  • CMake Architecture Diagram (developer_guides/tech/images/cmake_build_pipeline_architecture.svg): Updated the toolchain box to reflect --llvm-clang (Xtensa Fork) and wrapper invocation.

Signed-off-by: Liam Girdwood liam.r.girdwood@linux.intel.com

Align Clang toolchain documentation across getting started, CMake
build system, and module integration guides to point to Liam Girdwood's
llvm-project fork repository and its authoritative README.md.

Changes:
- In getting_started/index.rst, replace redundant/diverging inlined
  compiler build and workspace clone steps with a direct pointer to
  https://github.com/lgirdwood/llvm-project (branch llvm-stable)
  and its authoritative README.md.
- In developer_guides/tech/cmake.rst, remove erroneous environment
  variables (ZEPHYR_TOOLCHAIN_VARIANT=llvm, LLVM_TOOLCHAIN_PATH) and
  manual 'west build ... app/' commands. Document that Clang builds
  are driven via 'xtensa-build-zephyr.py --llvm-clang', point to the
  fork README, and retain the mandatory Integrated Assembler (IAS) policy.
- In developer_guides/firmware/module_integration_guide.rst, update
  the toolchain comparison table build command to use --llvm-clang
  and cross-reference the fork README.
- In developer_guides/tech/images/cmake_build_pipeline_architecture.svg,
  update the toolchain box to reflect '--llvm-clang (Xtensa Fork)'
  and wrapper invocation.

Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>
@lgirdwood
lgirdwood merged commit 4fa8f1f into thesofproject:master Sep 21, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants