diff --git a/doc/application/index.rst b/doc/application/index.rst index 73d6b2e40a3..c71002a6c3c 100644 --- a/doc/application/index.rst +++ b/doc/application/index.rst @@ -605,6 +605,28 @@ The other pages in the :ref:`Kconfig section of the manual ` 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 ===================