diff --git a/doc/nrf/includes/sample_snippets.txt b/doc/nrf/includes/sample_snippets.txt index 0ab4cf7edaf9..58b1b13a8b81 100644 --- a/doc/nrf/includes/sample_snippets.txt +++ b/doc/nrf/includes/sample_snippets.txt @@ -1,5 +1,5 @@ The sample provides predefined :ref:`zephyr:snippets` for typical use cases, and to activate sample extensions. You can find the snippets in the :file:`snippets` directory of the sample. -Specify the corresponding snippet names in the :makevar:`SNIPPET` option when building with CMake, or as a ``-S`` argument when using west. +Specify the corresponding snippet names in the |SNIPPET| CMake option. For more information about using snippets, see :ref:`zephyr:using-snippets` in the Zephyr documentation. diff --git a/doc/nrf/protocols/thread/certification.rst b/doc/nrf/protocols/thread/certification.rst index 84db3af2240f..4351d9c03e24 100644 --- a/doc/nrf/protocols/thread/certification.rst +++ b/doc/nrf/protocols/thread/certification.rst @@ -66,26 +66,27 @@ Complete the following steps to prepare for the certification tests: #. Build the certification image. - Use the :ref:`ot_cli_sample` sample as a base, and apply the ``ci`` and ``multiprotocol`` snippets. + Use the :ref:`ot_cli_sample` sample as a base and apply the ``ci`` and ``multiprotocol`` snippets. + If you are building for the ``nrf5340dk/nrf5340/cpuapp`` target, also set the :kconfig:option:`SB_CONFIG_NETCORE_MULTIPROTOCOL_RPMSG` Kconfig option to ``y``. * If building on the command line, use the following command: .. code-block:: cd ncs/nrf/samples/openthread/cli/ - west build -b nrf52840dk/nrf52840 -S ci -S multiprotocol -- -DCONFIG_OPENTHREAD_LIBRARY=y + west build -b nrf52840dk/nrf52840 -- -Dcli_SNIPPET="ci;multiprotocol" -DCONFIG_OPENTHREAD_LIBRARY=y * If building using Visual Studio Code, you must first `create and build the application `_ using the CLI sample. Add the following lines to the **Additional CMake arguments** text field: .. code-block:: - -DSNIPPET="ci;multiprotocol" + -Dcli_SNIPPET="ci;multiprotocol" -DCONFIG_OPENTHREAD_LIBRARY=y .. note:: The configuration option selects the precompiled OpenThread libraries. - The ``multiprotocol`` snippet enables :ref:`multiprotocol support ` with Bluetooth® LE advertising. + The ``multiprotocol`` snippet and the :kconfig:option:`SB_CONFIG_NETCORE_MULTIPROTOCOL_RPMSG` Kconfig option enable :ref:`multiprotocol support ` with Bluetooth® LE advertising. #. Prepare Thread Test Harness. diff --git a/doc/nrf/protocols/thread/overview/power_consumption.rst b/doc/nrf/protocols/thread/overview/power_consumption.rst index 38d830fbc775..536e5852e76c 100644 --- a/doc/nrf/protocols/thread/overview/power_consumption.rst +++ b/doc/nrf/protocols/thread/overview/power_consumption.rst @@ -25,7 +25,7 @@ The leader board is flashed with the regular :ref:`Thread CLI sample ` firmware. In the build command below, replace ``build-target`` with the build target name of the DUT. @@ -33,7 +33,7 @@ In the build command below, replace ``build-target`` with the build target name .. code-block:: cd ncs/nrf/samples/openthread/cli/ - west build -b build-target -S ci -S low_power + west build -b build-target -- -Dcli_SNIPPET="ci;low_power" After the Thread network is enabled on the leader, the child is configured with the desired parameters. diff --git a/samples/openthread/cli/README.rst b/samples/openthread/cli/README.rst index 7b03794255e5..c880678b6556 100644 --- a/samples/openthread/cli/README.rst +++ b/samples/openthread/cli/README.rst @@ -90,6 +90,8 @@ Configuration Snippets ======== +.. |snippet| replace:: :makevar:`cli_SNIPPET` + .. include:: /includes/sample_snippets.txt The following snippets are available: @@ -101,6 +103,10 @@ The following snippets are available: * ``ci`` - Disables boot banner and shell prompt. * ``multiprotocol`` - Enables Bluetooth LE support in this sample. Not compatible with the ``tcat`` snippet. + + .. note:: + When building with the ``multiprotocol`` snippet for the ``nrf5340dk/nrf5340/cpuapp`` build target, the :kconfig:option:`SB_CONFIG_NETCORE_MULTIPROTOCOL_RPMSG` Kconfig option has to be set to ``y``. + * ``tcat`` - Enables support for Thread commissioning over authenticated TLS. Not compatible with the ``multiprotocol`` snippet. For using TCAT, refer to the :ref:`thread_tcat` page. diff --git a/samples/openthread/coap_client/README.rst b/samples/openthread/coap_client/README.rst index 597a76e2d034..17f8afb79f17 100644 --- a/samples/openthread/coap_client/README.rst +++ b/samples/openthread/coap_client/README.rst @@ -116,6 +116,8 @@ Configuration Snippets ======== +.. |snippet| replace:: :makevar:`coap_client_SNIPPET` + .. include:: /includes/sample_snippets.txt The following snippets are available: @@ -126,6 +128,9 @@ The following snippets are available: For additional options, refer to :ref:`RTT logging `. * ``multiprotocol_ble`` - Enables the Multiprotocol Bluetooth LE extension. + .. note:: + When building with ``multiprotocol_ble`` snippet, for the ``nrf5340dk/nrf5340/cpuapp`` build target, additional :kconfig:option:`SB_CONFIG_NETCORE_MULTIPROTOCOL_RPMSG` option has to be set. + FEM support =========== diff --git a/samples/openthread/coap_server/README.rst b/samples/openthread/coap_server/README.rst index 0db6b48700aa..de2ab4d3f4ad 100644 --- a/samples/openthread/coap_server/README.rst +++ b/samples/openthread/coap_server/README.rst @@ -64,6 +64,8 @@ Configuration Snippets ======== +.. |snippet| replace:: :makevar:`coap_server_SNIPPET` + .. include:: /includes/sample_snippets.txt The following snippets are available: diff --git a/samples/openthread/coprocessor/README.rst b/samples/openthread/coprocessor/README.rst index 0a836b4f83a1..ecbcfecdc2ee 100644 --- a/samples/openthread/coprocessor/README.rst +++ b/samples/openthread/coprocessor/README.rst @@ -99,6 +99,8 @@ Check and configure the following library option that is used by the sample: Snippets ======== +.. |snippet| replace:: :makevar:`coprocessor_SNIPPET` + .. include:: /includes/sample_snippets.txt The following snippets are available: