From 0c436bad932fea1741de8aa97cb5f36ff4c6fa35 Mon Sep 17 00:00:00 2001 From: Armando Montanez Date: Wed, 12 Jun 2024 16:28:49 -0700 Subject: [PATCH] Minor docs clarifications --- bazel/README.md | 5 +++-- bazel/config/BUILD.bazel | 4 ++-- src/common/pico_base/BUILD.bazel | 1 - 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/bazel/README.md b/bazel/README.md index 6409cf4c9..1db0c930e 100644 --- a/bazel/README.md +++ b/bazel/README.md @@ -71,8 +71,9 @@ $ bazelisk build --platforms=//bazel/platform:rp2040 --@pico-sdk//bazel/config:P If you have a bespoke board definition, you can configure the Pico SDK to use it by pointing `--@pico-sdk//bazel/config:PICO_CONFIG_HEADER` to a `cc_library` -that defines `PICO_BOARD` and `PICO_CONFIG_HEADER`, also providing any necessary -`includes`. +that defines `PICO_BOARD` and either a `PICO_CONFIG_HEADER` define or a +`pico/config_autogen.h` header. Make sure any required `includes`, `hdrs`, and +`deps` are also provided. ## Generating UF2 firmware images Creation of UF2 images can be done as explicit build steps on a per-binary diff --git a/bazel/config/BUILD.bazel b/bazel/config/BUILD.bazel index 88dc5d3cc..50530ecfd 100644 --- a/bazel/config/BUILD.bazel +++ b/bazel/config/BUILD.bazel @@ -128,13 +128,13 @@ label_flag( build_setting_default = "//bazel:no_extra_headers", ) -# PICO_BAZEL_CONFIG: PICO_CONFIG_PLATFORM_HEADER, [Bazel only] The cc_library that provides "pico_config_platform_headers.h", default=//src/common/pico_base:default_platform_headers, group=pico_base +# PICO_BAZEL_CONFIG: PICO_CONFIG_PLATFORM_HEADER, [Bazel only] The cc_library that provides "pico_config_platform_headers.h" and defines PICO_BOARD, default=//src/common/pico_base:default_platform_headers, group=pico_base label_flag( name = "PICO_CONFIG_PLATFORM_HEADER", build_setting_default = "//src/boards:default", ) -# PICO_BAZEL_CONFIG: PICO_CONFIG_HEADER, [Bazel only] The cc_library that defines PICO_BOARD, PICO_CONFIG_HEADER, and other SDK critical defines (overrides PICO_BOARD setting), default=//bazel:generate_config_header, group=pico_base +# PICO_BAZEL_CONFIG: PICO_CONFIG_HEADER, [Bazel only] The cc_library that defines PICO_CONFIG_HEADER or pico/config_autogen.h and other SDK critical defines (overrides PICO_BOARD setting), default=//bazel:generate_config_header, group=pico_base label_flag( name = "PICO_CONFIG_HEADER", build_setting_default = "//bazel:generate_config_header", diff --git a/src/common/pico_base/BUILD.bazel b/src/common/pico_base/BUILD.bazel index 73fd1f2a4..4204efdfe 100644 --- a/src/common/pico_base/BUILD.bazel +++ b/src/common/pico_base/BUILD.bazel @@ -133,7 +133,6 @@ cc_library( deps = [ ":common_sdk_defines", ":version", - "//bazel:generate_config_header", "//bazel/config:PICO_CONFIG_HEADER", ], )