michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: samples: update OVERLAY_CONFIG to EXTRA_CONF_FILE

Browse source 
Update rst files to use EXTRA_CONF_FILE instead of OVERLAY_CONFIG.

Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
This commit is contained in:
Torsten Rasmussen 2023-05-17 15:57:24 +02:00 • committed by Carles Cufí
commit 1120934874
28 changed files with 48 additions and 48 deletions
Download patch file Download diff file Expand all files Collapse all files

2
samples/bluetooth/broadcast_audio_sink/README.rst
View file

@ -20,7 +20,7 @@ Building and Running
********************
This sample can be found under
:zephyr_file:`samples/bluetooth/broadcast_audio_sink` in the Zephyr tree.
Use `-DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf` to enable required ISO
Use `-DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf` to enable required ISO
feature support in Zephyr Bluetooth Controller on supported boards.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.

2
samples/bluetooth/broadcast_audio_source/README.rst
View file

@ -23,7 +23,7 @@ Building and Running
********************
This sample can be found under
:zephyr_file:`samples/bluetooth/broadcast_audio_source` in the Zephyr tree.
Use `-DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf` to enable required ISO
Use `-DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf` to enable required ISO
feature support in Zephyr Bluetooth Controller on supported boards.
See :ref:`bluetooth samples section <bluetooth-samples>` for details.

2
samples/bluetooth/direction_finding_central/README.rst
View file

@ -32,7 +32,7 @@ changing ``nrf52833dk_nrf52833`` as needed for your board:
:zephyr-app: samples/bluetooth/direction_finding_central
:host-os: unix
:board: nrf52833dk_nrf52833
:gen-args: -DOVERLAY_CONFIG=overlay-aod.conf
:gen-args: -DEXTRA_CONF_FILE=overlay-aod.conf
:goals: build flash
:compact:

2
samples/bluetooth/direction_finding_connectionless_rx/README.rst
View file

@ -32,7 +32,7 @@ changing ``nrf52833dk_nrf52833`` as needed for your board:
:zephyr-app: samples/bluetooth/direction_finding_connectionless_rx
:host-os: unix
:board: nrf52833dk_nrf52833
:gen-args: -DOVERLAY_CONFIG=overlay-aod.conf
:gen-args: -DEXTRA_CONF_FILE=overlay-aod.conf
:goals: build flash
:compact:

2
samples/bluetooth/direction_finding_connectionless_tx/README.rst
View file

@ -32,7 +32,7 @@ To use Angle of Arrival mode only, build this application as follows, changing
:zephyr-app: samples/bluetooth/direction_finding_connectionless_tx
:host-os: unix
:board: nrf52833dk_nrf52833
:gen-args: -DOVERLAY_CONFIG=overlay-aoa.conf
:gen-args: -DEXTRA_CONF_FILE=overlay-aoa.conf
:goals: build flash
:compact:

2
samples/bluetooth/direction_finding_peripheral/README.rst
View file

@ -31,7 +31,7 @@ changing ``nrf52833dk_nrf52833`` as needed for your board:
:zephyr-app: samples/bluetooth/direction_finding_peripheral
:host-os: unix
:board: nrf52833dk_nrf52833
:gen-args: -DOVERLAY_CONFIG=overlay-aoa.conf
:gen-args: -DEXTRA_CONF_FILE=overlay-aoa.conf
:goals: build flash
:compact:

2
samples/bluetooth/hci_uart/README.rst
View file

@ -122,7 +122,7 @@ application. To enable debug over RTT the debug configuration file can be used.
.. code-block:: console
west build samples/bluetooth/hci_uart -- -DOVERLAY_CONFIG='debug.conf'
west build samples/bluetooth/hci_uart -- -DEXTRA_CONF_FILE='debug.conf'
Then attach RTT as described here: :ref:`Using Segger J-Link <Using Segger J-Link>`

2
samples/bluetooth/iso_broadcast/README.rst
View file

@ -21,7 +21,7 @@ Building and Running
********************
This sample can be found under :zephyr_file:`samples/bluetooth/iso_broadcast` in
the Zephyr tree. Use `-DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf` to enable
the Zephyr tree. Use `-DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf` to enable
required ISO feature support in Zephyr Bluetooth Controller on supported boards.
Use the sample found under :zephyr_file:`samples/bluetooth/iso_receive` in the

2
samples/bluetooth/iso_receive/README.rst
View file

@ -21,7 +21,7 @@ Building and Running
********************
This sample can be found under :zephyr_file:`samples/bluetooth/iso_receive` in
the Zephyr tree. Use `-DOVERLAY_CONFIG=overlay-bt_ll_sw_split.conf` to enable
the Zephyr tree. Use `-DEXTRA_CONF_FILE=overlay-bt_ll_sw_split.conf` to enable
required ISO feature support in Zephyr Bluetooth Controller on supported boards.
Use the sample found under :zephyr_file:`samples/bluetooth/iso_broadcast` on

6
samples/drivers/spi_flash_at45/README.rst
View file

@ -51,7 +51,7 @@ To build and flash with device power management enabled:
.. zephyr-app-commands::
:zephyr-app: samples/drivers/spi_flash_at45
:board: nrf9160dk_nrf9160
:gen-args: -DOVERLAY_CONFIG=overlay-pm.conf
:gen-args: -DEXTRA_CONF_FILE=overlay-pm.conf
:goals: build flash
:compact:
@ -60,7 +60,7 @@ To build and flash with flash page layout enabled:
.. zephyr-app-commands::
:zephyr-app: samples/drivers/spi_flash_at45
:board: nrf9160dk_nrf9160
:gen-args: -DOVERLAY_CONFIG=overlay-page_layout.conf
:gen-args: -DEXTRA_CONF_FILE=overlay-page_layout.conf
:goals: build flash
:compact:
@ -70,7 +70,7 @@ layout enabled:
.. zephyr-app-commands::
:zephyr-app: samples/drivers/spi_flash_at45
:board: nrf9160dk_nrf9160
:gen-args: -DOVERLAY_CONFIG="overlay-pm.conf overlay-page_layout.conf"
:gen-args: -DEXTRA_CONF_FILE="overlay-pm.conf overlay-page_layout.conf"
:goals: build flash
:compact:

8
samples/net/cloud/tagoio_http_post/README.rst
View file

@ -68,7 +68,7 @@ need fill ``CONFIG_TAGOIO_HTTP_WIFI_SSID`` with your wifi network SSID and
.. zephyr-app-commands::
:zephyr-app: samples/net/cloud/tagoio_http_post
:board: disco_l475_iot1
:gen-args: -DOVERLAY_CONFIG=overlay-wifi.conf
:gen-args: -DEXTRA_CONF_FILE=overlay-wifi.conf
:goals: build flash
:compact:
@ -76,7 +76,7 @@ need fill ``CONFIG_TAGOIO_HTTP_WIFI_SSID`` with your wifi network SSID and
:zephyr-app: samples/net/cloud/tagoio_http_post
:board: [sam_v71_xult | frdm_k64f | nucleo_f767zi]
:shield: [esp_8266_arduino | inventek_eswifi_arduino_uart]
:gen-args: -DOVERLAY_CONFIG=overlay-wifi.conf
:gen-args: -DEXTRA_CONF_FILE=overlay-wifi.conf
:goals: build flash
:compact:
@ -97,14 +97,14 @@ a special designator like defined at ``arduino.overlay``.
.. zephyr-app-commands::
:zephyr-app: samples/net/cloud/tagoio_http_post
:board: sam4e_xpro
:gen-args: -DOVERLAY_CONFIG=overlay-modem.conf
:gen-args: -DEXTRA_CONF_FILE=overlay-modem.conf
:goals: build flash
:compact:
.. zephyr-app-commands::
:zephyr-app: samples/net/cloud/tagoio_http_post
:board: frdm_k64f
:gen-args: -DOVERLAY_CONFIG=overlay-modem.conf -DDTC_OVERLAY_FILE=arduino.overlay
:gen-args: -DEXTRA_CONF_FILE=overlay-modem.conf -DDTC_OVERLAY_FILE=arduino.overlay
:goals: build flash
:compact:

6
samples/net/mqtt_publisher/README.rst
View file

@ -129,7 +129,7 @@ try this sample with TLS enabled, by following these steps:
i.e., the IP address of test.mosquitto.org ``"37.187.106.16"``
- In :file:`src/main.c`, set TLS_SNI_HOSTNAME to ``"test.mosquitto.org"``
to match the Common Name (CN) in the downloaded certificate.
- Build the sample by specifying ``-DOVERLAY_CONFIG=overlay-tls.conf``
- Build the sample by specifying ``-DEXTRA_CONF_FILE=overlay-tls.conf``
when running ``west build`` or ``cmake`` (or refer to the TLS offloading
section below if your platform uses the offloading feature).
- Flash the binary onto the device to run the sample:
@ -142,7 +142,7 @@ TLS offloading
==============
For boards that support this feature, TLS offloading is used by
specifying ``-DOVERLAY_CONFIG=overlay-tls-offload.conf`` when running ``west
specifying ``-DEXTRA_CONF_FILE=overlay-tls-offload.conf`` when running ``west
build`` or ``cmake``.
Using this overlay enables TLS without bringing in mbedtls.
@ -151,7 +151,7 @@ SOCKS5 proxy support
====================
It is also possible to connect to the MQTT broker through a SOCKS5 proxy.
To enable it, use ``-DOVERLAY_CONFIG=overlay-socks5.conf`` when running ``west
To enable it, use ``-DEXTRA_CONF_FILE=overlay-socks5.conf`` when running ``west
build`` or ``cmake``.
By default, to make the testing easier, the proxy is expected to run on the

2
samples/net/openthread/coprocessor/README.rst
View file

@ -38,7 +38,7 @@ Build the OpenThread NCP sample application which uses CDC ACM UART device:
:zephyr-app: samples/net/openthread/coprocessor
:board: nrf52840dk_nrf52840
:goals: build flash
:gen-args: -DDTC_OVERLAY_FILE=usb.overlay -DOVERLAY_CONFIG=overlay-usb-nrf-br.conf
:gen-args: -DDTC_OVERLAY_FILE=usb.overlay -DEXTRA_CONF_FILE=overlay-usb-nrf-br.conf
:compact:
Example building for the nrf52840dk_nrf52840 for RCP:

2
samples/net/sockets/big_http_download/README.rst
View file

@ -74,7 +74,7 @@ Enable TLS support in the sample by building the project with the
:goals: build
:compact:
An alternative way is to specify ``-DOVERLAY_CONFIG=overlay-tls.conf`` when
An alternative way is to specify ``-DEXTRA_CONF_FILE=overlay-tls.conf`` when
running ``west build`` or ``cmake``.
The TLS version of this sample downloads a file from

6
samples/net/sockets/echo_client/README.rst
View file

@ -75,7 +75,7 @@ Example building for the IEEE 802.15.4 RF2XX transceiver:
:zephyr-app: samples/net/sockets/echo_client
:host-os: unix
:board: [atsamr21_xpro | sam4s_xplained | sam_v71_xult]
:gen-args: -DOVERLAY_CONFIG=overlay-802154.conf
:gen-args: -DEXTRA_CONF_FILE=overlay-802154.conf
:goals: build flash
:compact:
@ -100,7 +100,7 @@ Enable TLS support in the sample by building the project with the
:goals: build
:compact:
An alternative way is to specify ``-DOVERLAY_CONFIG=overlay-tls.conf`` when
An alternative way is to specify ``-DEXTRA_CONF_FILE=overlay-tls.conf`` when
running ``west build`` or ``cmake``.
The certificate and private key used by the sample can be found in the sample's
@ -112,7 +112,7 @@ SOCKS5 proxy support
====================
It is also possible to connect to the echo-server through a SOCKS5 proxy.
To enable it, use ``-DOVERLAY_CONFIG=overlay-socks5.conf`` when running ``west
To enable it, use ``-DEXTRA_CONF_FILE=overlay-socks5.conf`` when running ``west
build`` or ``cmake``.
By default, to make the testing easier, the proxy is expected to run on the

4
samples/net/sockets/echo_server/README.rst
View file

@ -82,7 +82,7 @@ Example building for the atsamr21_xpro with RF2XX driver support:
:zephyr-app: samples/net/sockets/echo_server
:host-os: unix
:board: [atsamr21_xpro | sam4e_xpro | sam_v71_xult]
:gen-args: -DOVERLAY_CONFIG=overlay-802154.conf
:gen-args: -DEXTRA_CONF_FILE=overlay-802154.conf
:goals: build flash
:compact:
@ -105,7 +105,7 @@ Enable TLS support in the sample by building the project with the
:goals: build
:compact:
An alternative way is to specify ``-DOVERLAY_CONFIG=overlay-tls.conf`` when
An alternative way is to specify ``-DEXTRA_CONF_FILE=overlay-tls.conf`` when
running ``west build`` or ``cmake``.
The certificate used by the sample can be found in the sample's ``src``

2
samples/net/sockets/http_client/README.rst
View file

@ -45,7 +45,7 @@ Enable TLS support in the sample by building the project with the
:goals: build
:compact:
An alternative way is to specify ``-DOVERLAY_CONFIG=overlay-tls.conf`` when
An alternative way is to specify ``-DEXTRA_CONF_FILE=overlay-tls.conf`` when
running ``west build`` or ``cmake``.
The certificate and private key used by the sample can be found in the sample's

2
samples/net/sockets/http_get/README.rst
View file

@ -53,7 +53,7 @@ Enable TLS support in the sample by building the project with the
:goals: build
:compact:
An alternative way is to specify ``-DOVERLAY_CONFIG=overlay-tls.conf`` when
An alternative way is to specify ``-DEXTRA_CONF_FILE=overlay-tls.conf`` when
running ``west build`` or ``cmake``.
For boards that support TLS offloading (e.g. TI's cc3220sf_launchxl), use

2
samples/net/sockets/tcp/README.rst
View file

@ -26,7 +26,7 @@ Build the TCP sample app:
cd samples/net/sockets/tcp
mkdir build && cd build
cmake -DBOARD=qemu_x86 -DOVERLAY_CONFIG="overlay-slip.conf" ..
cmake -DBOARD=qemu_x86 -DEXTRA_CONF_FILE="overlay-slip.conf" ..
make run
Compile and run the TCP sanity check `net-test-suites`_:

2
samples/net/sockets/websocket_client/README.rst
View file

@ -46,7 +46,7 @@ Enable TLS support in the sample by building the project with the
:goals: build
:compact:
An alternative way is to specify ``-DOVERLAY_CONFIG=overlay-tls.conf`` when
An alternative way is to specify ``-DEXTRA_CONF_FILE=overlay-tls.conf`` when
running ``west build`` or ``cmake``.
The certificate and private key used by the sample can be found in the sample's

2
samples/net/wpanusb/README.rst
View file

@ -39,7 +39,7 @@ Build the wpanusb sample for a board:
.. zephyr-app-commands::
:zephyr-app: samples/net/wpanusb
:board: <board to use>
:gen-args: -DOVERLAY_CONFIG=<overlay file to use>
:gen-args: -DEXTRA_CONF_FILE=<overlay file to use>
:goals: build
:compact:

2
samples/subsys/fs/fat_fs/README.rst
View file

@ -59,7 +59,7 @@ and DTS overlays need to be also selected. The command would look like this:
.. zephyr-app-commands::
:zephyr-app: samples/subsys/fs/fat_fs
:board: nrf52840dk_nrf52840
:gen-args: -DOVERLAY_CONFIG=nrf52840dk_nrf52840_qspi.conf -DDTC_OVERLAY_FILE=nrf52840dk_nrf52840_qspi.overlay
:gen-args: -DEXTRA_CONF_FILE=nrf52840dk_nrf52840_qspi.conf -DDTC_OVERLAY_FILE=nrf52840dk_nrf52840_qspi.overlay
:goals: build
:compact:

2
samples/subsys/lorawan/class_a/README.rst
View file

@ -38,5 +38,5 @@ enabled.
:zephyr-app: samples/subsys/lorawan/class_a
:board: nucleo_wl55jc
:goals: build flash
:gen-args: -DOVERLAY_CONFIG=overlay-clock-sync.conf
:gen-args: -DEXTRA_CONF_FILE=overlay-clock-sync.conf
:compact:

10
samples/subsys/mgmt/mcumgr/smp_svr/README.rst
View file

@ -93,7 +93,7 @@ Zephyr. The ``smp_svr`` sample comes in different flavours.
-b nrf52dk_nrf52832 \
samples/subsys/mgmt/mcumgr/smp_svr \
-- \
-DOVERLAY_CONFIG=overlay-bt.conf
-DEXTRA_CONF_FILE=overlay-bt.conf
.. group-tab:: Serial
@ -105,7 +105,7 @@ Zephyr. The ``smp_svr`` sample comes in different flavours.
-b frdm_k64f \
samples/subsys/mgmt/mcumgr/smp_svr \
-- \
-DOVERLAY_CONFIG='overlay-serial.conf;overlay-fs.conf;overlay-shell-mgmt.conf'
-DEXTRA_CONF_FILE='overlay-serial.conf;overlay-fs.conf;overlay-shell-mgmt.conf'
.. group-tab:: USB CDC_ACM
@ -117,7 +117,7 @@ Zephyr. The ``smp_svr`` sample comes in different flavours.
-b nrf52840dk_nrf52840 \
samples/subsys/mgmt/mcumgr/smp_svr \
-- \
-DOVERLAY_CONFIG=overlay-cdc.conf \
-DEXTRA_CONF_FILE=overlay-cdc.conf \
-DDTC_OVERLAY_FILE=usb.overlay
.. group-tab:: Shell
@ -130,7 +130,7 @@ Zephyr. The ``smp_svr`` sample comes in different flavours.
-b frdm_k64f \
samples/subsys/mgmt/mcumgr/smp_svr \
-- \
-DOVERLAY_CONFIG='overlay-shell.conf'
-DEXTRA_CONF_FILE='overlay-shell.conf'
.. group-tab:: UDP
@ -146,7 +146,7 @@ Zephyr. The ``smp_svr`` sample comes in different flavours.
-b frdm_k64f \
samples/subsys/mgmt/mcumgr/smp_svr \
-- \
-DOVERLAY_CONFIG=overlay-udp.conf
-DEXTRA_CONF_FILE=overlay-udp.conf
.. _smp_svr_sample_sign:

14
samples/subsys/mgmt/updatehub/README.rst
View file

@ -174,7 +174,7 @@ The ethernet depends only from base configuration.
:zephyr-app: zephyr/samples/subsys/mgmt/updatehub
:board: [ frdm_k64f | nucleo_f767zi ]
:build-dir: app
:gen-args: -DOVERLAY_CONFIG=overlay-prj.conf
:gen-args: -DEXTRA_CONF_FILE=overlay-prj.conf
:goals: build
:compact:
@ -189,7 +189,7 @@ for details.
:zephyr-app: zephyr/samples/subsys/mgmt/updatehub
:board: [ frdm_k64f | nrf52840dk_nrf52840 | nucleo_f767zi ]
:build-dir: app
:gen-args: -DOVERLAY_CONFIG="overlay-wifi.conf;overlay-prj.conf"
:gen-args: -DEXTRA_CONF_FILE="overlay-wifi.conf;overlay-prj.conf"
:shield: esp_8266_arduino
:goals: build
:compact:
@ -209,7 +209,7 @@ uses PPP over GSM modem, see :ref:`gsm-modem-sample`.
:zephyr-app: zephyr/samples/subsys/mgmt/updatehub
:board: [ frdm_k64f | nrf52840dk_nrf52840 | nucleo_f767zi ]
:build-dir: app
:gen-args: -DOVERLAY_CONFIG="overlay-modem.conf;overlay-prj.conf" \
:gen-args: -DEXTRA_CONF_FILE="overlay-modem.conf;overlay-prj.conf" \
-DDTC_OVERLAY_FILE=arduino.overlay
:goals: build
:compact:
@ -228,7 +228,7 @@ tested with both native linux driver and ``atusb`` and with ``wpanusb`` sample.
:zephyr-app: zephyr/samples/subsys/mgmt/updatehub
:board: nrf52840dk_nrf52840
:build-dir: app
:gen-args: -DOVERLAY_CONFIG="overlay-802154.conf;overlay-prj.conf"
:gen-args: -DEXTRA_CONF_FILE="overlay-802154.conf;overlay-prj.conf"
:goals: build
:compact:
@ -236,7 +236,7 @@ tested with both native linux driver and ``atusb`` and with ``wpanusb`` sample.
:zephyr-app: zephyr/samples/subsys/mgmt/updatehub
:board: [ frdm_k64f | nucleo_f767zi ]
:build-dir: app
:gen-args: -DOVERLAY_CONFIG="overlay-802154.conf;overlay-prj.conf"
:gen-args: -DEXTRA_CONF_FILE="overlay-802154.conf;overlay-prj.conf"
:shield: atmel_rf2xx_arduino
:goals: build
:compact:
@ -256,7 +256,7 @@ tested with native linux driver and an USB dongle.
:zephyr-app: zephyr/samples/subsys/mgmt/updatehub
:board: nrf52840dk_nrf52840
:build-dir: app
:gen-args: -DOVERLAY_CONFIG="overlay-ipsp.conf;overlay-prj.conf"
:gen-args: -DEXTRA_CONF_FILE="overlay-ipsp.conf;overlay-prj.conf"
:goals: build
:compact:
@ -274,7 +274,7 @@ gateway was tested using two boards with OpenThread 1.1.1 on NCP mode.
:zephyr-app: zephyr/samples/subsys/mgmt/updatehub
:board: nrf52840dk_nrf52840
:build-dir: app
:gen-args: -DOVERLAY_CONFIG="overlay-ot.conf;overlay-prj.conf"
:gen-args: -DEXTRA_CONF_FILE="overlay-ot.conf;overlay-prj.conf"
:goals: build
:compact:

2
samples/subsys/modbus/rtu_server/README.rst
View file

@ -67,7 +67,7 @@ The following commands build and flash RTU server sample using CDC ACM UART.
:zephyr-app: samples/subsys/modbus/rtu_server
:board: nrf52840dk_nrf52840
:goals: build flash
:gen-args: -DDTC_OVERLAY_FILE=cdc-acm.overlay -DOVERLAY_CONFIG=overlay-cdc-acm.conf
:gen-args: -DDTC_OVERLAY_FILE=cdc-acm.overlay -DEXTRA_CONF_FILE=overlay-cdc-acm.conf
:compact:
On the client side, PC or laptop, the following command connects PyModbus

2
samples/subsys/usb/dfu/README.rst
View file

@ -129,7 +129,7 @@ Both symbols can be enabled with the :file:`overlay-permanent-download.conf` ove
west build -b nrf52840dk_nrf52840 zephyr/samples/subsys/usb/dfu -d build-dfu -- \
-DCONFIG_BOOTLOADER_MCUBOOT=y '-DCONFIG_MCUBOOT_SIGNATURE_KEY_FILE="bootloader/mcuboot/root-rsa-2048.pem"' \
-DOVERLAY_CONFIG=overlay-permanent-download.conf
-DEXTRA_CONF_FILE=overlay-permanent-download.conf
The listing below shows the output to the console when downloading via dfu-util.

2
samples/subsys/usb/shell/README.rst
View file

@ -40,7 +40,7 @@ the platform has already defined or not `zephyr_uhc0` or `zephyr_udc0` nodelabel
.. zephyr-app-commands::
:zephyr-app: samples/subsys/usb/shell
:board: nrf52840dk_nrf52840
:gen-args: -DOVERLAY_CONFIG=virtual.conf -DDTC_OVERLAY_FILE=virtual.overlay
:gen-args: -DEXTRA_CONF_FILE=virtual.conf -DDTC_OVERLAY_FILE=virtual.overlay
:goals: flash
:compact: