This is an automated email from the ASF dual-hosted git repository.
xiaoxiang781216 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
The following commit(s) were added to refs/heads/master by this push:
new e17d776357f docs/guides/customboards: Mention special Kconfig settings
e17d776357f is described below
commit e17d776357f3c982edd8ec64311fc1906df78d3a
Author: Matteo Golin <[email protected]>
AuthorDate: Wed Jun 17 13:42:23 2026 -0400
docs/guides/customboards: Mention special Kconfig settings
This change mentions the special Kconfig settings for custom boards to
tell the build system about properties that are defined using the `HAVE`
options for in-tree boards. It also specifically mentions to avoid using
Kconfig `if` guards around the custom board Kconfig, which would be a
gotcha for people copying from in-tree boards.
Signed-off-by: Matteo Golin <[email protected]>
fix
---
Documentation/guides/customboards.rst | 41 +++++++++++++++++++++++++++++++++++
1 file changed, 41 insertions(+)
diff --git a/Documentation/guides/customboards.rst
b/Documentation/guides/customboards.rst
index b8624426a5e..76c3b3afb48 100644
--- a/Documentation/guides/customboards.rst
+++ b/Documentation/guides/customboards.rst
@@ -96,3 +96,44 @@ They should be set to suit your board name and directory
location.
.. Note::
If you subsequently run a ``make distclean`` operation, then these settings
will be lost.
They should be added back before building, and/or before running ``make
menuconfig``.
+
+Kconfig flags
+-------------
+
+Some boards make using of Kconfig ``ARCH_HAVE_*`` flags in order to be able to
+select certain features. For example, ``ARCH_HAVE_LEDS`` is a necessary flag
for
+enabling ``CONFIG_ARCH_LEDS=y`` because it tells the build system that the
board
+has LEDs. Selecting ``ARCH_HAVE_*`` flags happens inside the NuttX build
+system, so it is not accessible to custom boards. If you need to enable these
+flags, then you should select them manually with the ``BOARD_CUSTOM_*``
options:
+
+* ``BOARD_CUSTOM_LEDS`` selects ``ARCH_HAVE_LEDS``
+* ``BOARD_CUSTOM_BUTTONS`` selects ``ARCH_HAVE_BUTTONS``
+* ``BOARD_CUSTOM_IRQBUTTONS`` selects ``ARCH_HAVE_IRQBUTTONS``
+* ``BOARD_CUSTOM_INTERRUPT`` selects ``ARCH_PHY_INTERRUPT``
+
+If there are any other ``ARCH_HAVE_*`` selectors you cannot access but need for
+your custom board, please open an issue!
+
+Kconfig file
+------------
+
+You may have noticed that in-tree boards typically surround their board-level
+Kconfig logic with something like:
+
+.. code:: kconfig
+
+ if ARCH_BOARD_BOARDNAME
+ endif # ARCH_BOARD_BOARDAME
+
+You should **not** do this for custom boards; just write your Kconfig logic
+without the guard. However, it is still good practice to prefix your custom
+Kconfig options with the board name:
+
+.. code:: kconfig
+
+ config BOARDNAME_MYOPTION
+ bool "My custom option"
+ default n
+ ---help---
+ This is my custom option for my custom board.
