scripts: kconfigfunctions: add a comment
I can never remember what the contents of the kconfigfunctions dict is
and have to look it up every time. I suspect I'm not alone, and not
everyone who uses these will know how to look up the answer. Add a
comment explaining the value.
Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
diff --git a/scripts/kconfig/kconfigfunctions.py b/scripts/kconfig/kconfigfunctions.py
index a851564..957676a 100644
--- a/scripts/kconfig/kconfigfunctions.py
+++ b/scripts/kconfig/kconfigfunctions.py
@@ -418,6 +418,15 @@
return "y" if shield in list.split(";") else "n"
+# Keys in this dict are the function names as they appear
+# in Kconfig files. The values are tuples in this form:
+#
+# (python_function, minimum_number_of_args, maximum_number_of_args)
+#
+# Each python function is given a kconf object and its name in the
+# Kconfig file, followed by arguments from the Kconfig file.
+#
+# See the kconfiglib documentation for more details.
functions = {
"dt_compat_enabled": (dt_compat_enabled, 1, 1),
"dt_compat_on_bus": (dt_compat_on_bus, 2, 2),
