Skip to content

Commit

Permalink
doc: application: added description of WARN_EXPERIMENTAL setting
Browse files Browse the repository at this point in the history
This commit adds description of the `WARN_EXPERIMENTAL` Kconfig setting
to the application development guide.

It describes the use of `CONFIG_WARN_EXPERIMENTAL` along with an
example of the warning output when experimental features are enabled.

Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
  • Loading branch information
tejlmand authored and carlescufi committed Oct 22, 2021
1 parent 587285e commit f17630b
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions doc/application/index.rst
Expand Up @@ -605,6 +605,28 @@ The other pages in the :ref:`Kconfig section of the manual <kconfig>` are also
worth going through, especially if you planning to add new configuration
options.

Experimental features
*********************

Zephyr is a project under constant development and thus there are features that
are still in early stages of their development cycle. Such features will be
marked ``[EXPERIMENTAL]`` in their Kconfig title.

The :kconfig:`CONFIG_WARN_EXPERIMENTAL` setting can be used to enable warnings
at CMake configure time if any experimental feature is enabled.

.. code-block:: none
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.

.. code-block:: shell
warning: Experimental symbol BT_EXT_ADV is enabled.
Devicetree Overlays
===================

Expand Down

0 comments on commit f17630b

Please sign in to comment.