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 <[email protected]>
argentum-systems · Aug 15, 2024 · 50145bb · 50145bb
1 parent e60ad59
commit 50145bb
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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