Skip to content

Commit

Permalink
[nrf fromlist] doc: application: tweak experimental features text
Browse files Browse the repository at this point in the history
Upstream PR: zephyrproject-rtos#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 <[email protected]>
  • Loading branch information
mbolivar-nordic committed Feb 25, 2022
1 parent 1cd8339 commit 1c01b57
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions doc/application/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
===================
Expand Down

0 comments on commit 1c01b57

Please sign in to comment.