mgmt/mcumgr: Add Kconfig option naming notes

The commit adds Kconfig option naming notes to Kconfig
files of MCUmgr subsystem.

Signed-off-by: Dominik Ermel <[email protected]>

Author: de-nordic

subsys/mgmt/mcumgr/grp/fs_mgmt/Kconfig

@@ -2,6 +2,16 @@
 # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
+# The Kconfig file is dedicated to File System management group of
+# of MCUmgr subsystem and provides Kconfig options to configure
+# group commands behaviour and other aspects.
+#
+# Options defined in this file should be prefixed:
+#  MCUMGR_GRP_FS_ -- general group options;
+#
+# When adding Kconfig options, that control the same feature,
+# try to group them together by the same stem after prefix.
+
 menuconfig MCUMGR_GRP_FS
 	bool "Mcumgr handlers for file management (insecure)"
 	depends on FILE_SYSTEM

subsys/mgmt/mcumgr/grp/img_mgmt/Kconfig

@@ -2,6 +2,16 @@
 # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
+# The Kconfig file is dedicated to Application Image management group of
+# of MCUmgr subsystem and provides Kconfig options to configure
+# group commands behaviour and other aspects.
+#
+# Options defined in this file should be prefixed:
+#  MCUMGR_GRP_IMG_ -- general group options;
+#
+# When adding Kconfig options, that control the same feature,
+# try to group them together by the same stem after prefix.
+
 menuconfig MCUMGR_GRP_IMG
 	bool "Mcumgr handlers for image management"
 	select FLASH

subsys/mgmt/mcumgr/grp/os_mgmt/Kconfig

@@ -2,6 +2,16 @@
 # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
+# The Kconfig file is dedicated to OS management group of
+# of MCUmgr subsystem and provides Kconfig options to configure
+# group commands behaviour and other aspects.
+#
+# Options defined in this file should be prefixed:
+#  MCUMGR_GRP_OS_ -- general group options;
+#
+# When adding Kconfig options, that control the same feature,
+# try to group them together by the same stem after prefix.
+
 menuconfig MCUMGR_GRP_OS
 	bool "Mcumgr handlers for OS management"
 	select REBOOT

subsys/mgmt/mcumgr/grp/shell_mgmt/Kconfig

@@ -2,6 +2,16 @@
 # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
+# The Kconfig file is dedicated to Shell management group of
+# of MCUmgr subsystem and provides Kconfig options to configure
+# group commands behaviour and other aspects.
+#
+# Options defined in this file should be prefixed:
+#  MCUMGR_GRP_SHELL_ -- general group options;
+#
+# When adding Kconfig options, that control the same feature,
+# try to group them together by the same stem after prefix.
+
 menuconfig MCUMGR_GRP_SHELL
 	bool "Mcumgr handlers for shell management"
 	depends on SHELL

subsys/mgmt/mcumgr/grp/stat_mgmt/Kconfig

@@ -2,6 +2,16 @@
 # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
+# The Kconfig file is dedicated to Stat management group of
+# of MCUmgr subsystem and provides Kconfig options to configure
+# group commands behaviour and other aspects.
+#
+# Options defined in this file should be prefixed:
+#  MCUMGR_GRP_STAT_ -- general group options;
+#
+# When adding Kconfig options, that control the same feature,
+# try to group them together by the same stem after prefix.
+
 menuconfig MCUMGR_GRP_STAT
 	bool "Mcumgr handlers for statistics management"
 	depends on STATS

subsys/mgmt/mcumgr/mgmt/Kconfig

@@ -2,6 +2,13 @@
 # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
+# The Kconfig is dedicated to mgmt subsystem of MCUmgr. Kconfig options defined
+# here affect behaviour of services provided by source code of mcumgr/mgmt/
+# directory, like management group registration or overall hooks support.
+#
+# All Kconfig options defined with this file should begin with prefix:
+#  MCUMGR_MGMT_
+
 config MCUMGR_MGMT_NOTIFICATION_HOOKS
 	bool "MCUmgr notification hook support"
 	help

subsys/mgmt/mcumgr/smp/Kconfig

@@ -2,6 +2,15 @@
 # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
+# The Kconfig file is dedicated to smp subdirectory of MCUmgr
+# subsystem and provides Kconfig options to control aspects of
+# Simple Management Protocol (SMP) processing source code provided
+# under the subdirectory.
+#
+# Options defined in this file should be prefixed:
+#  MCUMGR_SMP_ -- for general SMP options;
+#  MCUMGR_SMP_CBOR -- for CBOR encoding specific options;
+
 config MCUMGR_SMP_CBOR_MAX_MAIN_MAP_ENTRIES
 	int "Number of predicted maximum entries to main response map"
 	default 15

subsys/mgmt/mcumgr/transport/Kconfig

@@ -2,6 +2,16 @@
 # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
+# The Kconfig file is dedicated to transport subdirectory of MCUmgr
+# subsystem and provides Kconfig options to control aspects of
+# transport, in general, that are not otherwise controlled by
+# options belonging to transport specifically.
+#
+# Options defined in this file should be prefixed:
+#  MCUMGR_TRANSPORT_ -- general transport options;
+#  MCUMGR_TRANSPORT_WORKQUEUE -- for workqueue configuration;
+#  MCUMGR_TRANSPORT_NETBUF -- for Net Buf related configuration.
+
 config MCUMGR_TRANSPORT_WORKQUEUE_STACK_SIZE
 	int "MCUmgr transport workqueue stack size"
 	default 2048

subsys/mgmt/mcumgr/transport/Kconfig.bluetooth

@@ -2,6 +2,13 @@
 # Copyright Nordic Semiconductor ASA 2020-2022. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
+# The Kconfig file is dedicated to Bluetooth transport of MCUmgr
+# subsystem and provides Kconfig options to control aspects of
+# the transport.
+#
+# Options defined in this file should be prefixed:
+#  MCUMGR_TRANSPORT_BT_
+
 menuconfig MCUMGR_TRANSPORT_BT
 	bool "Bluetooth mcumgr SMP transport"
 	select BT

subsys/mgmt/mcumgr/transport/Kconfig.dummy

@@ -2,6 +2,13 @@
 # Copyright Nordic Semiconductor ASA 2022. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
 
+# The Kconfig file is dedicated to Dummy transport of MCUmgr
+# subsystem and provides Kconfig options to control aspects of
+# the transport.
+#
+# Options defined in this file should be prefixed:
+#  MCUMGR_TRANSPORT_DUMMY_
+
 menuconfig MCUMGR_TRANSPORT_DUMMY
 	bool "Dummy SMP backend"
 	select BASE64