From 1c01b57ee6a3fa14f96a51fddb780c7f76ecbbc8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mart=C3=AD=20Bol=C3=ADvar?= Date: Wed, 16 Feb 2022 12:33:44 -0800 Subject: [PATCH] [nrf fromlist] doc: application: tweak experimental features text MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Upstream PR: https://github.com/zephyrproject-rtos/zephyr/pull/42876 We use a specific experimental Kconfig option when describing the behavior of CONFIG_WARN_EXPERIMENTAL. However, this option may not be experimental forever. This therefore may go stale. Rather than try to keep generic documentation about experimental options up to date with whatever the bluetooth subsystem happens to consider experimental or not, use a placeholder CONFIG_FOO instead of a real option. Signed-off-by: Martí Bolívar --- doc/application/index.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/application/index.rst b/doc/application/index.rst index 0cb6b17f0c494b..c44a8bc8eb7794 100644 --- a/doc/application/index.rst +++ b/doc/application/index.rst @@ -533,13 +533,13 @@ at CMake configure time if any experimental feature is enabled. CONFIG_WARN_EXPERIMENTAL=y -For example, enabling experimental warnings and building a sample which enables -:kconfig:`CONFIG_BT_EXT_ADV` will print the following warning at CMake -configure time. +For example, if option ``CONFIG_FOO`` is experimental, then enabling it and +:kconfig:`CONIG_WARN_EXPERIMENTAL` will print the following warning at CMake +configure time when you build an application: -.. code-block:: shell +.. code-block:: none - warning: Experimental symbol BT_EXT_ADV is enabled. + warning: Experimental symbol FOO is enabled. Devicetree Overlays ===================