Skip to content

Commit f17630b

Browse files
tejlmandcarlescufi
authored andcommitted
doc: application: added description of WARN_EXPERIMENTAL setting
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 <[email protected]>
1 parent 587285e commit f17630b

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

doc/application/index.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -605,6 +605,28 @@ The other pages in the :ref:`Kconfig section of the manual <kconfig>` are also
605605
worth going through, especially if you planning to add new configuration
606606
options.
607607

608+
Experimental features
609+
*********************
610+
611+
Zephyr is a project under constant development and thus there are features that
612+
are still in early stages of their development cycle. Such features will be
613+
marked ``[EXPERIMENTAL]`` in their Kconfig title.
614+
615+
The :kconfig:`CONFIG_WARN_EXPERIMENTAL` setting can be used to enable warnings
616+
at CMake configure time if any experimental feature is enabled.
617+
618+
.. code-block:: none
619+
620+
CONFIG_WARN_EXPERIMENTAL=y
621+
622+
For example, enabling experimental warnings and building a sample which enables
623+
:kconfig:`CONFIG_BT_EXT_ADV` will print the following warning at CMake
624+
configure time.
625+
626+
.. code-block:: shell
627+
628+
warning: Experimental symbol BT_EXT_ADV is enabled.
629+
608630
Devicetree Overlays
609631
===================
610632

0 commit comments

Comments
 (0)