From f9e3b65d3a9794ee2233aa88172346f887b48d04 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Cab=C3=A9?= Date: Fri, 19 Jul 2024 17:56:46 +0200 Subject: [PATCH] doc: porting_guide: fix ReStructuredText in Kconfig.plank MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Using < > in the kconfig:option role was causing the <_board> section to be omitted from the rendered docs, and using the role was useless anyway as the option name was not a real one. Use the fancy :samp: role instead to achieve the same goal. Signed-off-by: Benjamin Cabé --- doc/hardware/porting/board_porting.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/hardware/porting/board_porting.rst b/doc/hardware/porting/board_porting.rst index b2aede9b44be6d..0147c7c2679ca2 100644 --- a/doc/hardware/porting/board_porting.rst +++ b/doc/hardware/porting/board_porting.rst @@ -536,8 +536,8 @@ files for a board named ``plank``: config BOARD_PLANK select SOC_SOC1 - The Kconfig symbols :kconfig:option:`BOARD_` and - :kconfig:option:`BOARD_` are constructed by the build + The Kconfig symbols :samp:`BOARD_{board}` and + :samp:`BOARD_{normalized_board_target}` are constructed by the build system, therefore no type shall be defined in above code snippet. :file:`Kconfig`