From 6857a37d19d982b3a26a0917a09282d54e67dd92 Mon Sep 17 00:00:00 2001 From: Andrej Butok Date: Thu, 17 Oct 2024 11:28:15 +0200 Subject: [PATCH] doc: Use EXTRA_CONF_FILE in .rst/.md files Use EXTRA_CONF_FILE in documentation .rst/.md files, that replaced deprecated OVERLAY_CONFIG since the Zephyr v3.4 release. Signed-off-by: Andrej Butok --- boards/shields/arduino_uno_click/doc/index.rst | 2 +- boards/shields/atmel_rf2xx/doc/index.rst | 8 ++++---- doc/hardware/emulator/bus_emulators.rst | 2 +- samples/bluetooth/bap_broadcast_sink/README.rst | 4 ++-- samples/bluetooth/bap_broadcast_source/README.rst | 4 ++-- samples/bluetooth/bap_unicast_client/README.rst | 6 +++--- samples/bluetooth/bap_unicast_server/README.rst | 6 +++--- samples/bluetooth/cap_acceptor/README.rst | 4 ++-- samples/bluetooth/cap_initiator/README.rst | 4 ++-- samples/bluetooth/pbp_public_broadcast_sink/README.rst | 4 ++-- samples/bluetooth/pbp_public_broadcast_source/README.rst | 4 ++-- samples/subsys/shell/devmem_load/README.md | 2 +- 12 files changed, 25 insertions(+), 25 deletions(-) diff --git a/boards/shields/arduino_uno_click/doc/index.rst b/boards/shields/arduino_uno_click/doc/index.rst index 6c3ec052bbe..02a8ac576c6 100644 --- a/boards/shields/arduino_uno_click/doc/index.rst +++ b/boards/shields/arduino_uno_click/doc/index.rst @@ -45,7 +45,7 @@ other mikroBUS shields. For example: :zephyr-app: samples/net/sockets/echo_server :host-os: unix :board: sam_v71_xult/samv71q21 - :gen-args: -DOVERLAY_CONFIG=overlay-802154.conf + :gen-args: -DEXTRA_CONF_FILE=overlay-802154.conf :shield: arduino_uno_click,atmel_rf2xx_mikrobus :goals: build diff --git a/boards/shields/atmel_rf2xx/doc/index.rst b/boards/shields/atmel_rf2xx/doc/index.rst index 14c389e4701..d33a66a09b3 100644 --- a/boards/shields/atmel_rf2xx/doc/index.rst +++ b/boards/shields/atmel_rf2xx/doc/index.rst @@ -295,7 +295,7 @@ Set ``--shield `` when you invoke ``west build``. :zephyr-app: samples/net/sockets/echo_server :host-os: unix :board: sam4s_xplained - :gen-args: -DOVERLAY_CONFIG=overlay-802154.conf + :gen-args: -DEXTRA_CONF_FILE=overlay-802154.conf :shield: atmel_rf2xx_xplained :goals: build flash :compact: @@ -304,7 +304,7 @@ Set ``--shield `` when you invoke ``west build``. :zephyr-app: samples/net/sockets/echo_server :host-os: unix :board: [sam4e_xpro | sam_v71_xult/samv71q21] - :gen-args: -DOVERLAY_CONFIG=overlay-802154.conf + :gen-args: -DEXTRA_CONF_FILE=overlay-802154.conf :shield: [atmel_rf2xx_xpro | atmel_rf2xx_legacy] :goals: build flash :compact: @@ -313,7 +313,7 @@ Set ``--shield `` when you invoke ``west build``. :zephyr-app: samples/net/sockets/echo_server :host-os: unix :board: [sam_v71_xult/samv71q21 | frdm_k64f | nucleo_f767zi] - :gen-args: -DOVERLAY_CONFIG=overlay-802154.conf + :gen-args: -DEXTRA_CONF_FILE=overlay-802154.conf :shield: atmel_rf2xx_arduino :goals: build flash :compact: @@ -322,7 +322,7 @@ Set ``--shield `` when you invoke ``west build``. :zephyr-app: samples/net/sockets/echo_server :host-os: unix :board: lpcxpresso55s69_ns - :gen-args: -DOVERLAY_CONFIG=overlay-802154.conf + :gen-args: -DEXTRA_CONF_FILE=overlay-802154.conf :shield: atmel_rf2xx_microbus :goals: build flash :compact: diff --git a/doc/hardware/emulator/bus_emulators.rst b/doc/hardware/emulator/bus_emulators.rst index 381f0a1ad58..bac8796c618 100644 --- a/doc/hardware/emulator/bus_emulators.rst +++ b/doc/hardware/emulator/bus_emulators.rst @@ -195,7 +195,7 @@ Here are some examples present in Zephyr: :zephyr-app: tests/drivers/eeprom/api :board: native_sim :goals: build - :gen-args: -DDTC_OVERLAY_FILE=at2x_emul.overlay -DOVERLAY_CONFIG=at2x_emul.conf + :gen-args: -DDTC_OVERLAY_FILE=at2x_emul.overlay -DEXTRA_CONF_FILE=at2x_emul.conf API Reference ============= diff --git a/samples/bluetooth/bap_broadcast_sink/README.rst b/samples/bluetooth/bap_broadcast_sink/README.rst index b1539fa91eb..b1c87757598 100644 --- a/samples/bluetooth/bap_broadcast_sink/README.rst +++ b/samples/bluetooth/bap_broadcast_sink/README.rst @@ -30,7 +30,7 @@ Building and Running ******************** When building targeting an nrf52 series board with the Zephyr Bluetooth Controller, -use ``-DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf`` to enable the required ISO +use ``-DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf`` to enable the required ISO feature support. Building for an nrf5340dk @@ -77,4 +77,4 @@ Building for a simulated nrf52_bsim :zephyr-app: samples/bluetooth/bap_broadcast_sink/ :board: nrf52_bsim :goals: build - :gen-args: -DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf + :gen-args: -DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf diff --git a/samples/bluetooth/bap_broadcast_source/README.rst b/samples/bluetooth/bap_broadcast_source/README.rst index 35dac5313cf..501f4231b98 100644 --- a/samples/bluetooth/bap_broadcast_source/README.rst +++ b/samples/bluetooth/bap_broadcast_source/README.rst @@ -29,7 +29,7 @@ Building and Running ******************** When building targeting an nrf52 series board with the Zephyr Bluetooth Controller, -use ``-DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf`` to enable the required ISO +use ``-DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf`` to enable the required ISO feature support. Building for an nrf5340dk @@ -76,4 +76,4 @@ Building for a simulated nrf52_bsim :zephyr-app: samples/bluetooth/bap_broadcast_source/ :board: nrf52_bsim :goals: build - :gen-args: -DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf + :gen-args: -DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf diff --git a/samples/bluetooth/bap_unicast_client/README.rst b/samples/bluetooth/bap_unicast_client/README.rst index cc55f807809..fbdeb46fa7f 100644 --- a/samples/bluetooth/bap_unicast_client/README.rst +++ b/samples/bluetooth/bap_unicast_client/README.rst @@ -25,7 +25,7 @@ Building and Running ******************** When building targeting an nrf52 series board with the Zephyr Bluetooth Controller, -use ``-DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf`` to enable the required ISO +use ``-DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf`` to enable the required ISO feature support. Building for an nrf52840dk @@ -35,7 +35,7 @@ Building for an nrf52840dk :zephyr-app: samples/bluetooth/bap_unicast_client/ :board: nrf52840dk/nrf52840 :goals: build - :gen-args: -DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf + :gen-args: -DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf Building for an nrf5340dk ------------------------- @@ -69,7 +69,7 @@ Similarly to how you would for real HW, you can do: :zephyr-app: samples/bluetooth/bap_unicast_client/ :board: nrf52_bsim :goals: build - :gen-args: -DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf + :gen-args: -DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf Note this will produce a Linux executable in :file:`./build/zephyr/zephyr.exe`. For more information, check :ref:`this board documentation `. diff --git a/samples/bluetooth/bap_unicast_server/README.rst b/samples/bluetooth/bap_unicast_server/README.rst index 86505347772..a398b4e225e 100644 --- a/samples/bluetooth/bap_unicast_server/README.rst +++ b/samples/bluetooth/bap_unicast_server/README.rst @@ -25,7 +25,7 @@ Building and Running ******************** When building targeting an nrf52 series board with the Zephyr Bluetooth Controller, -use ``-DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf`` to enable the required ISO +use ``-DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf`` to enable the required ISO feature support. Building for an nrf52840dk @@ -35,7 +35,7 @@ Building for an nrf52840dk :zephyr-app: samples/bluetooth/bap_unicast_server/ :board: nrf52840dk/nrf52840 :goals: build - :gen-args: -DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf + :gen-args: -DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf Building for an nrf5340dk ------------------------- @@ -69,7 +69,7 @@ Similarly to how you would for real HW, you can do: :zephyr-app: samples/bluetooth/bap_unicast_server/ :board: nrf52_bsim :goals: build - :gen-args: -DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf + :gen-args: -DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf Note this will produce a Linux executable in :file:`./build/zephyr/zephyr.exe`. For more information, check :ref:`this board documentation `. diff --git a/samples/bluetooth/cap_acceptor/README.rst b/samples/bluetooth/cap_acceptor/README.rst index 5e148b21a63..20aa3be1c22 100644 --- a/samples/bluetooth/cap_acceptor/README.rst +++ b/samples/bluetooth/cap_acceptor/README.rst @@ -25,7 +25,7 @@ Building and Running ******************** When building targeting an nrf52 series board with the Zephyr Bluetooth Controller, -use ``-DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf`` to enable the required ISO +use ``-DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf`` to enable the required ISO feature support. Building for an nrf5340dk @@ -72,4 +72,4 @@ Building for a simulated nrf52_bsim :zephyr-app: samples/bluetooth/cap_acceptor/ :board: nrf52_bsim :goals: build - :gen-args: -DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf + :gen-args: -DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf diff --git a/samples/bluetooth/cap_initiator/README.rst b/samples/bluetooth/cap_initiator/README.rst index d82c76c135d..4b90ec553da 100644 --- a/samples/bluetooth/cap_initiator/README.rst +++ b/samples/bluetooth/cap_initiator/README.rst @@ -25,7 +25,7 @@ Building and Running ******************** When building targeting an nrf52 series board with the Zephyr Bluetooth Controller, -use ``-DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf`` to enable the required ISO +use ``-DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf`` to enable the required ISO feature support. Building for an nrf5340dk @@ -72,4 +72,4 @@ Building for a simulated nrf52_bsim :zephyr-app: samples/bluetooth/cap_initiator/ :board: nrf52_bsim :goals: build - :gen-args: -DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf + :gen-args: -DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf diff --git a/samples/bluetooth/pbp_public_broadcast_sink/README.rst b/samples/bluetooth/pbp_public_broadcast_sink/README.rst index 928bce51635..222e035b2cd 100644 --- a/samples/bluetooth/pbp_public_broadcast_sink/README.rst +++ b/samples/bluetooth/pbp_public_broadcast_sink/README.rst @@ -27,7 +27,7 @@ Building and Running ******************** When building targeting an nrf52 series board with the Zephyr Bluetooth Controller, -use ``-DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf`` to enable the required ISO +use ``-DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf`` to enable the required ISO feature support. Building for an nrf5340dk @@ -74,4 +74,4 @@ Building for a simulated nrf52_bsim :zephyr-app: samples/bluetooth/pbp_public_broadcast_sink/ :board: nrf52_bsim :goals: build - :gen-args: -DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf + :gen-args: -DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf diff --git a/samples/bluetooth/pbp_public_broadcast_source/README.rst b/samples/bluetooth/pbp_public_broadcast_source/README.rst index a491a7fe5f3..dca75699c1d 100644 --- a/samples/bluetooth/pbp_public_broadcast_source/README.rst +++ b/samples/bluetooth/pbp_public_broadcast_source/README.rst @@ -27,7 +27,7 @@ Building and Running ******************** When building targeting an nrf52 series board with the Zephyr Bluetooth Controller, -use ``-DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf`` to enable the required ISO +use ``-DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf`` to enable the required ISO feature support. Building for an nrf5340dk @@ -74,4 +74,4 @@ Building for a simulated nrf52_bsim :zephyr-app: samples/bluetooth/pbp_public_broadcast_source/ :board: nrf52_bsim :goals: build - :gen-args: -DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf + :gen-args: -DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf diff --git a/samples/subsys/shell/devmem_load/README.md b/samples/subsys/shell/devmem_load/README.md index 98b4059dcaf..9238ed31c5e 100644 --- a/samples/subsys/shell/devmem_load/README.md +++ b/samples/subsys/shell/devmem_load/README.md @@ -20,7 +20,7 @@ west flash Building for boards without UART interrupt support: ```bash -west build -b native_sim -- -DOVERLAY_CONFIG=prj_poll.conf samples/subsys/shell/devmem_load +west build -b native_sim -- -DEXTRA_CONF_FILE=prj_poll.conf samples/subsys/shell/devmem_load ``` ## Running After connecting to the UART console you should see the following output: