From 12c73da2976096c3cc53d7ebbfc7101821c12106 Mon Sep 17 00:00:00 2001 From: Nikola Radakovic Date: Mon, 22 Jun 2026 10:52:54 +0100 Subject: [PATCH 1/4] docs: Provide additional information in docs Update examples_and_validation.md to state examples only validate module extension changes and are not a platform setup reference. Standardize supported platform family entries in overview.md with explicit AMD64/ARM64 names and Bazel identifiers. Clarify QNX shared license path and agreement with platform/module owners in qnx_integration.md. Add a note in repository_layout.md that examples should not be used as a platform development reference. --- docs/examples_and_validation.md | 8 +++++++- docs/overview.md | 10 +++++----- docs/qnx_integration.md | 5 +++-- docs/repository_layout.md | 15 ++++----------- 4 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/examples_and_validation.md b/docs/examples_and_validation.md index b2a4eb7..4baca2f 100644 --- a/docs/examples_and_validation.md +++ b/docs/examples_and_validation.md @@ -24,6 +24,12 @@ It demonstrates how consumers declare toolchains while also serving as the main smoke-test surface for validating that the generated toolchains can build and, where appropriate, run example targets. +These examples are intended only for sanity testing global changes on the +module extension side. They are not a reference point for full platform setup. +For a proper build on a dedicated platform, consumers must consult the +relevant platform developers and owners rather than relying on these examples +as a platform configuration guide. + ## Important Files `examples/MODULE.bazel` @@ -69,7 +75,7 @@ cd examples ## What The Tests Prove -The example workspace is not intended to be an exhaustive compiler correctness +As stated before, the example workspace is not intended to be an exhaustive compiler correctness suite. Instead, it answers a narrower question: did the configuration repository produce a usable toolchain definition for each supported scenario? diff --git a/docs/overview.md b/docs/overview.md index 7857e31..ef90584 100644 --- a/docs/overview.md +++ b/docs/overview.md @@ -44,11 +44,11 @@ them as `cc_toolchain` targets: The current repository surface supports these platform families: -- Linux `x86_64` with packaged GCC toolchains -- Linux `aarch64` with packaged GCC toolchains -- Linux runtime-specific variants such as AutoSD and EB corbos Linux for Safety Applications -- QNX `x86_64` with packaged or locally built SDP-based toolchains -- QNX `aarch64` with packaged or locally built SDP-based toolchains +- Linux AMD64 (`x86_64-linux`) with packaged GCC toolchains +- Linux ARM64 (`aarch64-linux`) with packaged GCC toolchains +- Linux runtime-specific variants (`x86_64-linux`, `aarch64-linux`) such as `AutoSD` and `EB corbos Linux for Safety Applications` +- QNX AMD64 (`x86_64-qnx`) with packaged or locally built SDP-based toolchains +- QNX ARM64 (`aarch64-qnx`) with packaged or locally built SDP-based toolchains ## Core Design Model diff --git a/docs/qnx_integration.md b/docs/qnx_integration.md index 12cd058..6cb08f3 100644 --- a/docs/qnx_integration.md +++ b/docs/qnx_integration.md @@ -27,7 +27,8 @@ Relevant `gcc.toolchain(...)` attributes are: - `license_info_variable` - `license_info_url` -The default shared license path is `/opt/score_qnx/license/licenses`. +The default shared license path is `/opt/score_qnx/license/licenses`. This has been +agreed with all modules owners and platform developers. ## Credential Helper @@ -36,7 +37,7 @@ Authenticated QNX downloads are handled by the standalone script Its purpose is to translate locally available QNX credentials into the cookie header format expected by `qnx.com` download endpoints. Bazel executes it via -`--credential_helper`; it is not referenced as a Bazel target. +`--credential_helper`; Supported registration patterns include: diff --git a/docs/repository_layout.md b/docs/repository_layout.md index a2818b1..19f2959 100644 --- a/docs/repository_layout.md +++ b/docs/repository_layout.md @@ -56,24 +56,17 @@ Holds the template files used by repository rules. These templates are rendered into the generated toolchain repository and differ between Linux and QNX because the execution environment, sysroot layout, and licensing model are different. +> NOTE: Future plan is to have single template for toolchain configuiration. `examples/` A standalone Bazel workspace used as an integration surface. It declares representative toolchain configurations and validates them with a smoke-test runner. +> NOTE: This tests are just for sanity check. They should not be used as reference +> poinst for platform development. `tools/` Contains utility scripts that Bazel executes directly, most notably the QNX -credential helper used for authenticated downloads from `qnx.com`. - -## How These Pieces Relate - -Each directory is part of a single flow: - -- `packages/` defines *what* to fetch, -- `templates/` define *what to generate*, -- `rules/` define *how to generate it*, -- `extensions/` define *how consumers ask for it*, -- `examples/` prove that the generated result actually works. \ No newline at end of file +credential helper used for authenticated downloads from `qnx.com`. \ No newline at end of file From f605cd7ee6ccc409a947b6b77adf6d69ad3633de Mon Sep 17 00:00:00 2001 From: Alexander Lanin Date: Mon, 22 Jun 2026 12:50:11 +0200 Subject: [PATCH 2/4] fix typo Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Alexander Lanin --- docs/repository_layout.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/repository_layout.md b/docs/repository_layout.md index 19f2959..dafd65c 100644 --- a/docs/repository_layout.md +++ b/docs/repository_layout.md @@ -56,7 +56,7 @@ Holds the template files used by repository rules. These templates are rendered into the generated toolchain repository and differ between Linux and QNX because the execution environment, sysroot layout, and licensing model are different. -> NOTE: Future plan is to have single template for toolchain configuiration. +> NOTE: Future plan is to have a single template for toolchain configuration. `examples/` From e0b74c5ba9a30e23c05b38ed9f1f208bbcde84aa Mon Sep 17 00:00:00 2001 From: Alexander Lanin Date: Mon, 22 Jun 2026 12:50:25 +0200 Subject: [PATCH 3/4] fix typo Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Alexander Lanin --- docs/repository_layout.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/repository_layout.md b/docs/repository_layout.md index dafd65c..de56b21 100644 --- a/docs/repository_layout.md +++ b/docs/repository_layout.md @@ -63,8 +63,8 @@ different. A standalone Bazel workspace used as an integration surface. It declares representative toolchain configurations and validates them with a smoke-test runner. -> NOTE: This tests are just for sanity check. They should not be used as reference -> poinst for platform development. +> NOTE: These tests are just a sanity check. They should not be used as reference +> points for platform development. `tools/` From d12b6722c3dbd6b61ee511e0ba184ede482275ca Mon Sep 17 00:00:00 2001 From: Alexander Lanin Date: Mon, 22 Jun 2026 12:50:42 +0200 Subject: [PATCH 4/4] fix typo Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Alexander Lanin --- docs/qnx_integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/qnx_integration.md b/docs/qnx_integration.md index 6cb08f3..fe5aabc 100644 --- a/docs/qnx_integration.md +++ b/docs/qnx_integration.md @@ -28,7 +28,7 @@ Relevant `gcc.toolchain(...)` attributes are: - `license_info_url` The default shared license path is `/opt/score_qnx/license/licenses`. This has been -agreed with all modules owners and platform developers. +agreed with all module owners and platform developers. ## Credential Helper