Skip to content

Commit

Permalink
doc: porting_guide: fix ReStructuredText in Kconfig.plank
Browse files Browse the repository at this point in the history
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é <benjamin@zephyrproject.org>
  • Loading branch information
kartben authored and aescolar committed Jul 21, 2024
1 parent 52a9e70 commit f9e3b65
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/hardware/porting/board_porting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -536,8 +536,8 @@ files for a board named ``plank``:
config BOARD_PLANK
select SOC_SOC1
The Kconfig symbols :kconfig:option:`BOARD_<board>` and
:kconfig:option:`BOARD_<normalized_board_target>` 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`
Expand Down

0 comments on commit f9e3b65

Please sign in to comment.