From 73f080e3ffcc168b8977006123664d93fb199126 Mon Sep 17 00:00:00 2001
From: Pawel Langowski <pawel.langowski@3mdeb.com>
Date: Fri, 6 Jun 2025 14:07:03 +0200
Subject: [PATCH] dts-functions: parse_config: Add comments

Signed-off-by: Pawel Langowski <pawel.langowski@3mdeb.com>
---
 include/dts-functions.sh | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/include/dts-functions.sh b/include/dts-functions.sh
index d1ad2ed..25321d9 100644
--- a/include/dts-functions.sh
+++ b/include/dts-functions.sh
@@ -1835,17 +1835,48 @@ parse_config() {
   local vendor="$1"
   local system_model="$2"
   local board_model="$3"
+  # The JSONs names in configs directory the same as values in vendor variable
+  # but lowercase and spaces replaced with _
   json_file="$BOARD_CONFIG_PATH/configs/$(echo "$vendor" | tr '[:upper:]' '[:lower:]' | sed 's/ /_/g').json"
   # Parse common variables for vendor
+  # This finds all keys other than `models` and maps them to bash variables.
+  # The variable names are converted to lowercase.
+  #
+  # to_entries[] | select(.key != "models")
+  # Converts JSON input from:
+  # "key1": "value"
+  # "key2": "value"
+  # "models": {
+  #   "key3": "value"
+  #  }
+  # To:
+  # "key1": "value"
+  # "key2": "value"
+  #
+  # "\(.key | ascii_upcase)=\"\(.value|tostring)\"
+  # Changes: "key1": "value" to: KEY1="value"
   eval $(jq -r 'to_entries[] | select(.key != "models") | "\(.key | ascii_upcase)=\"\(.value|tostring)\""' $json_file)
+
   # Parse system model-specific variables
+  # This finds all keys in `models[$SYSTEM_MODEL]` other than `board_models`
+  # and assigns variables just like in the previous call
+  #
+  # --arg m $(echo "$system_model" ...) stores the lowercase value of
+  # $system_model in the "$m" jq variable. That variable is then used to access
+  # models[$system_model] (.models[$m])
   eval $(jq -r --arg m $(echo "$system_model" | tr '[:upper:]' '[:lower:]') '
   .models[$m] 
   | to_entries[] 
   | select(.key != "board_models")
   | "\(.key | ascii_upcase)=\"\(.value|tostring)\""
 ' $json_file)
+
   # If separate BOARD_MODEL values exist, parse the variables 
+  # This looks for `models[$SYSTEM_MODEL].board_models[$BOARD_MODEL]`. Some 
+  # boards have different variable values for different board models.
+  #
+  # If .models[$m].board_models[$b] does not exist, the eval will not
+  # create any new variables
   eval $(jq -r --arg m $(echo "$system_model" | tr '[:upper:]' '[:lower:]') --arg b $(echo "$board_model" | tr '[:upper:]' '[:lower:]') '
   if .models[$m].board_models[$b] then
     .models[$m].board_models[$b]