From 50145bbf6147176a70f81c28f2416e0330c7009a Mon Sep 17 00:00:00 2001 From: Alberto Escolar Piedras Date: Tue, 13 Aug 2024 10:30:22 +0200 Subject: [PATCH] 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 --- Kconfig.zephyr | 2 ++ boards/Kconfig | 2 ++ soc/Kconfig | 2 ++ 3 files changed, 6 insertions(+) diff --git a/Kconfig.zephyr b/Kconfig.zephyr index 3b689ec97bd..0e5c665b21d 100644 --- a/Kconfig.zephyr +++ b/Kconfig.zephyr @@ -949,6 +949,8 @@ config DEPRECATED help Symbol that must be selected by a feature or module if it is 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 bool diff --git a/boards/Kconfig b/boards/Kconfig index 13599252b72..6eb9ca5916d 100644 --- a/boards/Kconfig +++ b/boards/Kconfig @@ -37,6 +37,8 @@ config BOARD_DEPRECATED_RELEASE the Zephyr release that the board configuration will be removed. When set, any build for that board will generate a clearly visible 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 bool diff --git a/soc/Kconfig b/soc/Kconfig index 51af8596287..af32c5c5cf3 100644 --- a/soc/Kconfig +++ b/soc/Kconfig @@ -58,6 +58,8 @@ config SOC_DEPRECATED_RELEASE the Zephyr release that the SoC configuration will be removed. When set, any build for that SoC will generate a clearly visible 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 bool