Kconfig: Link to deprecation instructions

Let's link from the deprecated instructions.
To increase visibility and hopefully avoid developers forgetting to
do so.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
This commit is contained in:
Alberto Escolar Piedras 2024-08-13 10:30:22 +02:00 committed by Alberto Escolar
parent e60ad59e9f
commit 50145bbf61
3 changed files with 6 additions and 0 deletions

View File

@ -949,6 +949,8 @@ config DEPRECATED
help help
Symbol that must be selected by a feature or module if it is Symbol that must be selected by a feature or module if it is
considered to be deprecated. considered to be deprecated.
When adding this to an option, remember to follow the instructions in
https://docs.zephyrproject.org/latest/develop/api/api_lifecycle.html#deprecated
config WARN_DEPRECATED config WARN_DEPRECATED
bool bool

View File

@ -37,6 +37,8 @@ config BOARD_DEPRECATED_RELEASE
the Zephyr release that the board configuration will be removed. the Zephyr release that the board configuration will be removed.
When set, any build for that board will generate a clearly visible When set, any build for that board will generate a clearly visible
deprecation warning. deprecation warning.
When adding this to a BOARD, remember to follow the instructions in
https://docs.zephyrproject.org/latest/develop/api/api_lifecycle.html#deprecated
config QEMU_TARGET config QEMU_TARGET
bool bool

View File

@ -58,6 +58,8 @@ config SOC_DEPRECATED_RELEASE
the Zephyr release that the SoC configuration will be removed. the Zephyr release that the SoC configuration will be removed.
When set, any build for that SoC will generate a clearly visible When set, any build for that SoC will generate a clearly visible
deprecation warning. deprecation warning.
When adding this to a SOC, remember to follow the instructions in
https://docs.zephyrproject.org/latest/develop/api/api_lifecycle.html#deprecated
config SOC_HAS_TIMING_FUNCTIONS config SOC_HAS_TIMING_FUNCTIONS
bool bool