Skip to contentSkip to conversation

scripts: merge_config: add strict mode to fail upon any redefinition

PATCH In review Matthias Maennich 3 participants 4 messages Dec 2, 2020 – Aug 2, 2021 3 messages not in the archive

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 scripts: merge_config: add strict mode to fail upon any redefinition

When merging configuration fragments, it might be of interest to identify mismatches (redefinitions) programmatically. Hence add the option -s (strict mode) to instruct merge_config.sh to bail out in case any redefinition has been detected.

With strict mode, warnings are emitted as before, but the script terminates with rc=1. If -y is set to define "builtin having precedence over modules", fragments are still allowed to set =m (while the base config has =y). Strict mode will tolerate that as demotions from =y to =m are ignored when setting -y.

---
 scripts/kconfig/merge_config.sh | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
scripts/kconfig/merge_config.sh +15 -0
index 63c8565206a4..d0b957b20cbf 100755
@@ -28,6 +28,7 @@ usage() {
 	echo "  -r    list redundant entries when merging fragments"
 	echo "  -y    make builtin have precedence over modules"
 	echo "  -O    dir to put generated output files.  Consider setting \$KCONFIG_CONFIG instead."
+	echo "  -s    strict mode. Fail if the fragment redefines any value."
 	echo
 	echo "Used prefix: '$CONFIG_PREFIX'. You can redefine it with \$CONFIG_ environment variable."
 }
@@ -37,6 +38,7 @@ ALLTARGET=alldefconfig
 WARNREDUN=false
 BUILTIN=false
 OUTPUT=.
+STRICT=false
 CONFIG_PREFIX=${CONFIG_-CONFIG_}
 
 while true; do
@@ -75,6 +77,11 @@ while true; do
 		shift 2
 		continue
 		;;
+	"-s")
+		STRICT=true
+		shift
+		continue
+		;;
 	*)
 		break
 		;;
@@ -141,6 +148,9 @@ for ORIG_MERGE_FILE in $MERGE_LIST ; do
 			echo Previous  value: $PREV_VAL
 			echo New value:       $NEW_VAL
 			echo
+			if [ "$STRICT" = "true" ]; then
+				STRICT_MODE_VIOLATED=true
+			fi
 		elif [ "$WARNREDUN" = "true" ]; then
 			echo Value of $CFG is redundant by fragment $ORIG_MERGE_FILE:
 		fi
@@ -153,6 +163,11 @@ for ORIG_MERGE_FILE in $MERGE_LIST ; do
 	cat $MERGE_FILE >> $TMP_FILE
 done
 
+if [ "$STRICT_MODE_VIOLATED" = "true" ]; then
+	echo "The fragment redefined a value and strict mode had been passed."
+	exit 1
+fi
+
 if [ "$RUNMAKE" = "false" ]; then
 	cp -T -- "$TMP_FILE" "$KCONFIG_CONFIG"
 	echo "#"
Signature · 1 line
2.29.2.454.gaff20da3a2-goog

A message that is not in the archive (sent off-list or not yet received): CAF2Aj3jS6+RN5mEeF+65MRsyMR9BMecMmxwr3sfjwd64zA6Acw@mail.gmail.com

A message that is not in the archive (sent off-list or not yet received): CAF2Aj3hWWoQvezD4Ma01LrhUwGLobNk40H9ArvjT5+XeNE3vMw@mail.gmail.com

#3 lore raw
Quoted 25 lines · Lee Jones

Masahiro,

Quoted 21 lines · Lee Jones
Quoted 17 lines · Matthias Maennich

When merging configuration fragments, it might be of interest to identify mismatches (redefinitions) programmatically. Hence add the option -s (strict mode) to instruct merge_config.sh to bail out in case any redefinition has been detected.

With strict mode, warnings are emitted as before, but the script terminates with rc=1. If -y is set to define "builtin having precedence over modules", fragments are still allowed to set =m (while the base config has =y). Strict mode will tolerate that as demotions from =y to =m are ignored when setting -y.

---
 scripts/kconfig/merge_config.sh | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
Quoted 4 lines
Quoted 1 line

Any idea what's holding this up please?

Simply because I hate this script.

merge_config.sh itself is a bad hack.
I do not like to extend it further.

Not only this one.
I saw more people with
"hey, I came up with a new option for merge_config.sh" to do whatever they like to do.

However, it might be too late anyway.

So, I can merge this patch if people believe
it is useful.

Signature · 2 lines
Best Regards
Masahiro Yamada

A message that is not in the archive (sent off-list or not yet received): CAF2Aj3hS0kxrnf+kePWmYAT3A-+PTVQ7_6yWj1nO8BLjwGZGQg@mail.gmail.com

#5 lore raw
Quoted 34 lines · Lee Jones
Quoted 32 lines · On Sat, 24 Jul 2021, 14:57 Masahiro Yamada, <[email protected]> wrote:
Quoted 29 lines · Lee Jones

Masahiro,

Quoted 14 lines · Lee Jones
Quoted 12 lines · Matthias Maennich

When merging configuration fragments, it might be of interest to identify mismatches (redefinitions) programmatically. Hence add the option -s (strict mode) to instruct merge_config.sh to bail out in case any redefinition has been detected.

With strict mode, warnings are emitted as before, but the script terminates with rc=1. If -y is set to define "builtin having precedence over modules", fragments are still allowed to set =m (while the base config has =y). Strict mode will tolerate that as demotions from =y to =m are ignored when setting -y.

Quoted 8 lines
Quoted 5 lines
---
 scripts/kconfig/merge_config.sh | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Any idea what's holding this up please?

Quoted 8 lines
Quoted 5 lines

Simply because I hate this script.

merge_config.sh itself is a bad hack.
I do not like to extend it further.

Sorry you feel that way Masahiro.

I do not know why merge_config was implemented as
a separate shell script while all the other
functions were contained in the kconfig binary.

Anyway...

Quoted 8 lines
Quoted 8 lines

Not only this one.
I saw more people with
"hey, I came up with a new option for merge_config.sh" to do whatever they like to do.

However, it might be too late anyway.

Quoted 7 lines
Quoted 2 lines

So, I can merge this patch if people believe
it is useful.

I know of multiple entities who make good use of the script and this extension.

My vote is to merge it, but ultimately this is your train set.

OK, I decided to not care about it too much.

Now applied to linux-kbuild. Thanks.

Signature · 2 lines
Best Regards
Masahiro Yamada
#6 lore raw
Quoted 7 lines
Quoted 3 lines

I know of multiple entities who make good use of the script and this extension.

My vote is to merge it, but ultimately this is your train set.

OK, I decided to not care about it too much.

Now applied to linux-kbuild. Thanks.

Thanks Masahiro. Much appreciated.

Signature · 4 lines
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog