Skip to contentSkip to conversation

devtools: adjust verbosity of ABI check

PATCH Superseded Thomas Monjalon 3 participants 6 messages Dec 7, 2020 – Jan 13, 2021 Arm/Amlogic Meson SoC support

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 devtools: adjust verbosity of ABI check

The scripts gen-abi.sh and check-abi.sh are updated
to print error messages to stderr so they are likely never ignored.

When called from test-meson-builds.sh, the standard messages on stdout can be more quiet depending on the verbosity settings.
The beginning of the ABI check is announced in verbose mode. The commands are printed in very verbose mode.
The check result details are available in verbose mode.

---
 devtools/check-abi.sh         | 21 +++++++++++----------
 devtools/gen-abi.sh           |  4 ++--
 devtools/test-meson-builds.sh |  9 +++++++--
 3 files changed, 20 insertions(+), 14 deletions(-)
devtools/check-abi.sh +11 -10
index ab6748cfbc..381db2cdd1 100755
@@ -3,7 +3,7 @@
 # Copyright (c) 2019 Red Hat, Inc.
 
 if [ $# != 2 ] && [ $# != 3 ]; then
-	echo "Usage: $0 refdir newdir [warnonly]"
+	echo "Usage: $0 refdir newdir [warnonly]" >&2
 	exit 1
 fi
 
@@ -13,23 +13,23 @@ warnonly=${3:-}
 ABIDIFF_OPTIONS="--suppr $(dirname $0)/libabigail.abignore --no-added-syms"
 
 if [ ! -d $refdir ]; then
-	echo "Error: reference directory '$refdir' does not exist."
+	echo "Error: reference directory '$refdir' does not exist." >&2
 	exit 1
 fi
 incdir=$(find $refdir -type d -a -name include)
 if [ -z "$incdir" ] || [ ! -e "$incdir" ]; then
-	echo "WARNING: could not identify a include directory for $refdir, expect false positives..."
+	echo "WARNING: could not identify an include directory for $refdir, expect false positives..." >&2
 else
 	ABIDIFF_OPTIONS="$ABIDIFF_OPTIONS --headers-dir1 $incdir"
 fi
 
 if [ ! -d $newdir ]; then
-	echo "Error: directory to check '$newdir' does not exist."
+	echo "Error: directory to check '$newdir' does not exist." >&2
 	exit 1
 fi
 incdir2=$(find $newdir -type d -a -name include)
 if [ -z "$incdir2" ] || [ ! -e "$incdir2" ]; then
-	echo "WARNING: could not identify a include directory for $newdir, expect false positives..."
+	echo "WARNING: could not identify an include directory for $newdir, expect false positives..." >&2
 else
 	ABIDIFF_OPTIONS="$ABIDIFF_OPTIONS --headers-dir2 $incdir2"
 fi
@@ -46,23 +46,24 @@ for dump in $(find $refdir -name "*.dump"); do
 	fi
 	dump2=$(find $newdir -name $name)
 	if [ -z "$dump2" ] || [ ! -e "$dump2" ]; then
-		echo "Error: can't find $name in $newdir"
+		echo "Error: cannot find $name in $newdir" >&2
 		error=1
 		continue
 	fi
+	echo abidiff $ABIDIFF_OPTIONS $dump $dump2
 	abidiff $ABIDIFF_OPTIONS $dump $dump2 || {
 		abiret=$?
-		echo "Error: ABI issue reported for 'abidiff $ABIDIFF_OPTIONS $dump $dump2'"
+		echo "Error: ABI issue reported for 'abidiff $ABIDIFF_OPTIONS $dump $dump2'" >&2
 		error=1
 		echo
 		if [ $(($abiret & 3)) -ne 0 ]; then
-			echo "ABIDIFF_ERROR|ABIDIFF_USAGE_ERROR, this could be a script or environment issue."
+			echo "ABIDIFF_ERROR|ABIDIFF_USAGE_ERROR, this could be a script or environment issue." >&2
 		fi
 		if [ $(($abiret & 4)) -ne 0 ]; then
-			echo "ABIDIFF_ABI_CHANGE, this change requires a review (abidiff flagged this as a potential issue)."
+			echo "ABIDIFF_ABI_CHANGE, this change requires a review (abidiff flagged this as a potential issue)." >&2
 		fi
 		if [ $(($abiret & 8)) -ne 0 ]; then
-			echo "ABIDIFF_ABI_INCOMPATIBLE_CHANGE, this change breaks the ABI."
+			echo "ABIDIFF_ABI_INCOMPATIBLE_CHANGE, this change breaks the ABI." >&2
 		fi
 		echo
 	}
devtools/gen-abi.sh +2 -2
index c44b0e228a..f15a3b9aaf 100755
@@ -3,13 +3,13 @@
 # Copyright (c) 2019 Red Hat, Inc.
 
 if [ $# != 1 ]; then
-	echo "Usage: $0 installdir"
+	echo "Usage: $0 installdir" >&2
 	exit 1
 fi
 
 installdir=$1
 if [ ! -d $installdir ]; then
-	echo "Error: install directory '$installdir' does not exist."
+	echo "Error: install directory '$installdir' does not exist." >&2
 	exit 1
 fi
 
devtools/test-meson-builds.sh +7 -2
index ed44d4ffb1..16a81b6241 100755
@@ -194,10 +194,15 @@ build () # <directory> <target compiler | cross file> <meson options>
 
 		install_target $builds_dir/$targetdir \
 			$(readlink -f $builds_dir/$targetdir/install)
+		echo "Checking ABI compatibility of $targetdir" >&$verbose
+		echo $srcdir/devtools/gen-abi.sh \
+			$(readlink -f $builds_dir/$targetdir/install) >&$veryverbose
 		$srcdir/devtools/gen-abi.sh \
-			$(readlink -f $builds_dir/$targetdir/install)
+			$(readlink -f $builds_dir/$targetdir/install) >&$veryverbose
+		echo $srcdir/devtools/check-abi.sh $abirefdir/$targetdir \
+			$(readlink -f $builds_dir/$targetdir/install) >&$veryverbose
 		$srcdir/devtools/check-abi.sh $abirefdir/$targetdir \
-			$(readlink -f $builds_dir/$targetdir/install)
+			$(readlink -f $builds_dir/$targetdir/install) >&$verbose
 	fi
 }
 
Signature · 1 line
2.29.2
#1 lore raw
Quoted 8 lines · Thomas Monjalon

The scripts gen-abi.sh and check-abi.sh are updated
to print error messages to stderr so they are likely never ignored.

When called from test-meson-builds.sh, the standard messages on stdout can be more quiet depending on the verbosity settings.
The beginning of the ABI check is announced in verbose mode. The commands are printed in very verbose mode.
The check result details are available in verbose mode.

So there is a bit of a disconnect here - you change gen-abi/check-abi to correctly direct errors to sterr.

You then however provide a method to ignore them in test_meson_build.sh. I thinking giving people a way of ignoring the indicated lines below, is a bad plan.

No problem with the changes to check-abi/gen-abi - but I think the changes to test_meson_build.sh are a bad idea.

Quoted 120 lines
---
 devtools/check-abi.sh         | 21 +++++++++++----------
 devtools/gen-abi.sh           |  4 ++--
 devtools/test-meson-builds.sh |  9 +++++++--
 3 files changed, 20 insertions(+), 14 deletions(-)
devtools/check-abi.sh +11 -10
index ab6748cfbc..381db2cdd1 100755
@@ -3,7 +3,7 @@
 # Copyright (c) 2019 Red Hat, Inc.
 
 if [ $# != 2 ] && [ $# != 3 ]; then
-	echo "Usage: $0 refdir newdir [warnonly]"
+	echo "Usage: $0 refdir newdir [warnonly]" >&2
 	exit 1
 fi
 
@@ -13,23 +13,23 @@ warnonly=${3:-}
 ABIDIFF_OPTIONS="--suppr $(dirname $0)/libabigail.abignore --no-added-syms"
 
 if [ ! -d $refdir ]; then
-	echo "Error: reference directory '$refdir' does not exist."
+	echo "Error: reference directory '$refdir' does not exist." >&2
 	exit 1
 fi
 incdir=$(find $refdir -type d -a -name include)
 if [ -z "$incdir" ] || [ ! -e "$incdir" ]; then
-	echo "WARNING: could not identify a include directory for $refdir, expect false positives..."
+	echo "WARNING: could not identify an include directory for $refdir, expect false positives..." >&2
 else
 	ABIDIFF_OPTIONS="$ABIDIFF_OPTIONS --headers-dir1 $incdir"
 fi
 
 if [ ! -d $newdir ]; then
-	echo "Error: directory to check '$newdir' does not exist."
+	echo "Error: directory to check '$newdir' does not exist." >&2
 	exit 1
 fi
 incdir2=$(find $newdir -type d -a -name include)
 if [ -z "$incdir2" ] || [ ! -e "$incdir2" ]; then
-	echo "WARNING: could not identify a include directory for $newdir, expect false positives..."
+	echo "WARNING: could not identify an include directory for $newdir, expect false positives..." >&2
 else
 	ABIDIFF_OPTIONS="$ABIDIFF_OPTIONS --headers-dir2 $incdir2"
 fi
@@ -46,23 +46,24 @@ for dump in $(find $refdir -name "*.dump"); do
 	fi
 	dump2=$(find $newdir -name $name)
 	if [ -z "$dump2" ] || [ ! -e "$dump2" ]; then
-		echo "Error: can't find $name in $newdir"
+		echo "Error: cannot find $name in $newdir" >&2
 		error=1
 		continue
 	fi
+	echo abidiff $ABIDIFF_OPTIONS $dump $dump2
 	abidiff $ABIDIFF_OPTIONS $dump $dump2 || {
 		abiret=$?
-		echo "Error: ABI issue reported for 'abidiff $ABIDIFF_OPTIONS $dump $dump2'"
+		echo "Error: ABI issue reported for 'abidiff $ABIDIFF_OPTIONS $dump $dump2'" >&2
 		error=1
 		echo
 		if [ $(($abiret & 3)) -ne 0 ]; then
-			echo "ABIDIFF_ERROR|ABIDIFF_USAGE_ERROR, this could be a script or environment issue."
+			echo "ABIDIFF_ERROR|ABIDIFF_USAGE_ERROR, this could be a script or environment issue." >&2
 		fi
 		if [ $(($abiret & 4)) -ne 0 ]; then
-			echo "ABIDIFF_ABI_CHANGE, this change requires a review (abidiff flagged this as a potential issue)."
+			echo "ABIDIFF_ABI_CHANGE, this change requires a review (abidiff flagged this as a potential issue)." >&2
 		fi
 		if [ $(($abiret & 8)) -ne 0 ]; then
-			echo "ABIDIFF_ABI_INCOMPATIBLE_CHANGE, this change breaks the ABI."
+			echo "ABIDIFF_ABI_INCOMPATIBLE_CHANGE, this change breaks the ABI." >&2>  		fi
 		echo
 	}
devtools/gen-abi.sh +2 -2
index c44b0e228a..f15a3b9aaf 100755
@@ -3,13 +3,13 @@
 # Copyright (c) 2019 Red Hat, Inc.
 
 if [ $# != 1 ]; then
-	echo "Usage: $0 installdir"
+	echo "Usage: $0 installdir" >&2
 	exit 1
 fi
 
 installdir=$1
 if [ ! -d $installdir ]; then
-	echo "Error: install directory '$installdir' does not exist."
+	echo "Error: install directory '$installdir' does not exist." >&2
 	exit 1
 fi
 
devtools/test-meson-builds.sh +7 -2
index ed44d4ffb1..16a81b6241 100755
@@ -194,10 +194,15 @@ build () # <directory> <target compiler | cross file> <meson options>
 
 		install_target $builds_dir/$targetdir \
 			$(readlink -f $builds_dir/$targetdir/install)
+		echo "Checking ABI compatibility of $targetdir" >&$verbose
+		echo $srcdir/devtools/gen-abi.sh \
+			$(readlink -f $builds_dir/$targetdir/install) >&$veryverbose
 		$srcdir/devtools/gen-abi.sh \
-			$(readlink -f $builds_dir/$targetdir/install)
+			$(readlink -f $builds_dir/$targetdir/install) >&$veryverbose
+		echo $srcdir/devtools/check-abi.sh $abirefdir/$targetdir \
+			$(readlink -f $builds_dir/$targetdir/install) >&$veryverbose
 		$srcdir/devtools/check-abi.sh $abirefdir/$targetdir \
-			$(readlink -f $builds_dir/$targetdir/install)
+			$(readlink -f $builds_dir/$targetdir/install) >&$verbose
 	fi
 }
 
#2 lore raw

08/12/2020 16:22, Kinsella, Ray:

Quoted 14 lines · Thomas Monjalon
Quoted 8 lines

The scripts gen-abi.sh and check-abi.sh are updated
to print error messages to stderr so they are likely never ignored.

When called from test-meson-builds.sh, the standard messages on stdout can be more quiet depending on the verbosity settings.
The beginning of the ABI check is announced in verbose mode. The commands are printed in very verbose mode.
The check result details are available in verbose mode.

So there is a bit of a disconnect here - you change gen-abi/check-abi to correctly direct errors to sterr.

Quoted 6 lines

You then however provide a method to ignore them in test_meson_build.sh. I thinking giving people a way of ignoring the indicated lines below, is a bad plan.

No problem with the changes to check-abi/gen-abi - but I think the changes to test_meson_build.sh are a bad idea.

No the errors are not ignored.
Only stdout (report details) is redirected.

Quoted 3 lines
Quoted 3 lines
devtools/test-meson-builds.sh +1 -1
 		$srcdir/devtools/check-abi.sh $abirefdir/$targetdir \
-			$(readlink -f $builds_dir/$targetdir/install)
+			$(readlink -f $builds_dir/$targetdir/install) >&$verbose
#3 lore raw
In reply to Thomas Monjalon
Quoted 4 lines · Thomas Monjalon
devtools/check-abi.sh +0 -0
index ab6748cfbc..381db2cdd1 100755

[snip]

devtools/check-abi.sh for dump in $(find $refdir -name "*.dump"); do · line 53

Quoted 10 lines
devtools/check-abi.sh +2 -1
@@ -46,23 +46,24 @@ for dump in $(find $refdir -name "*.dump"); do
        fi
        dump2=$(find $newdir -name $name)
        if [ -z "$dump2" ] || [ ! -e "$dump2" ]; then
-               echo "Error: can't find $name in $newdir"
+               echo "Error: cannot find $name in $newdir" >&2
                error=1
                continue
        fi
+       echo abidiff $ABIDIFF_OPTIONS $dump $dump2

On error, this same command is repeated below, so I don't see the need for this new debug message.

Quoted 6 lines
devtools/check-abi.sh +1 -1
        abidiff $ABIDIFF_OPTIONS $dump $dump2 || {
                abiret=$?
-               echo "Error: ABI issue reported for 'abidiff $ABIDIFF_OPTIONS $dump $dump2'"
+               echo "Error: ABI issue reported for 'abidiff $ABIDIFF_OPTIONS $dump $dump2'" >&2
                error=1
                echo
Signature · 1 line
David Marchand
#4 lore raw

PATCH v2 1/1 devtools: adjust verbosity of ABI check

In reply to Thomas Monjalon

The scripts gen-abi.sh and check-abi.sh are updated
to print error messages to stderr so they are likely never ignored.

When called from test-meson-builds.sh, the standard messages on stdout can be more quiet depending on the verbosity settings.
The beginning of the ABI check is announced in verbose mode. The commands are printed in very verbose mode.
The check result details are available in verbose mode.

---
v2: remove abidiff command from stdout (already printed on error)

---
 devtools/check-abi.sh         | 20 ++++++++++----------
 devtools/gen-abi.sh           |  4 ++--
 devtools/test-meson-builds.sh |  9 +++++++--
 3 files changed, 19 insertions(+), 14 deletions(-)
devtools/check-abi.sh +10 -10
index ab6748cfbc..9835e346da 100755
@@ -3,7 +3,7 @@
 # Copyright (c) 2019 Red Hat, Inc.
 
 if [ $# != 2 ] && [ $# != 3 ]; then
-	echo "Usage: $0 refdir newdir [warnonly]"
+	echo "Usage: $0 refdir newdir [warnonly]" >&2
 	exit 1
 fi
 
@@ -13,23 +13,23 @@ warnonly=${3:-}
 ABIDIFF_OPTIONS="--suppr $(dirname $0)/libabigail.abignore --no-added-syms"
 
 if [ ! -d $refdir ]; then
-	echo "Error: reference directory '$refdir' does not exist."
+	echo "Error: reference directory '$refdir' does not exist." >&2
 	exit 1
 fi
 incdir=$(find $refdir -type d -a -name include)
 if [ -z "$incdir" ] || [ ! -e "$incdir" ]; then
-	echo "WARNING: could not identify a include directory for $refdir, expect false positives..."
+	echo "WARNING: could not identify an include directory for $refdir, expect false positives..." >&2
 else
 	ABIDIFF_OPTIONS="$ABIDIFF_OPTIONS --headers-dir1 $incdir"
 fi
 
 if [ ! -d $newdir ]; then
-	echo "Error: directory to check '$newdir' does not exist."
+	echo "Error: directory to check '$newdir' does not exist." >&2
 	exit 1
 fi
 incdir2=$(find $newdir -type d -a -name include)
 if [ -z "$incdir2" ] || [ ! -e "$incdir2" ]; then
-	echo "WARNING: could not identify a include directory for $newdir, expect false positives..."
+	echo "WARNING: could not identify an include directory for $newdir, expect false positives..." >&2
 else
 	ABIDIFF_OPTIONS="$ABIDIFF_OPTIONS --headers-dir2 $incdir2"
 fi
@@ -46,23 +46,23 @@ for dump in $(find $refdir -name "*.dump"); do
 	fi
 	dump2=$(find $newdir -name $name)
 	if [ -z "$dump2" ] || [ ! -e "$dump2" ]; then
-		echo "Error: can't find $name in $newdir"
+		echo "Error: cannot find $name in $newdir" >&2
 		error=1
 		continue
 	fi
 	abidiff $ABIDIFF_OPTIONS $dump $dump2 || {
 		abiret=$?
-		echo "Error: ABI issue reported for 'abidiff $ABIDIFF_OPTIONS $dump $dump2'"
+		echo "Error: ABI issue reported for 'abidiff $ABIDIFF_OPTIONS $dump $dump2'" >&2
 		error=1
 		echo
 		if [ $(($abiret & 3)) -ne 0 ]; then
-			echo "ABIDIFF_ERROR|ABIDIFF_USAGE_ERROR, this could be a script or environment issue."
+			echo "ABIDIFF_ERROR|ABIDIFF_USAGE_ERROR, this could be a script or environment issue." >&2
 		fi
 		if [ $(($abiret & 4)) -ne 0 ]; then
-			echo "ABIDIFF_ABI_CHANGE, this change requires a review (abidiff flagged this as a potential issue)."
+			echo "ABIDIFF_ABI_CHANGE, this change requires a review (abidiff flagged this as a potential issue)." >&2
 		fi
 		if [ $(($abiret & 8)) -ne 0 ]; then
-			echo "ABIDIFF_ABI_INCOMPATIBLE_CHANGE, this change breaks the ABI."
+			echo "ABIDIFF_ABI_INCOMPATIBLE_CHANGE, this change breaks the ABI." >&2
 		fi
 		echo
 	}
devtools/gen-abi.sh +2 -2
index c44b0e228a..f15a3b9aaf 100755
@@ -3,13 +3,13 @@
 # Copyright (c) 2019 Red Hat, Inc.
 
 if [ $# != 1 ]; then
-	echo "Usage: $0 installdir"
+	echo "Usage: $0 installdir" >&2
 	exit 1
 fi
 
 installdir=$1
 if [ ! -d $installdir ]; then
-	echo "Error: install directory '$installdir' does not exist."
+	echo "Error: install directory '$installdir' does not exist." >&2
 	exit 1
 fi
 
devtools/test-meson-builds.sh +7 -2
index ed44d4ffb1..16a81b6241 100755
@@ -194,10 +194,15 @@ build () # <directory> <target compiler | cross file> <meson options>
 
 		install_target $builds_dir/$targetdir \
 			$(readlink -f $builds_dir/$targetdir/install)
+		echo "Checking ABI compatibility of $targetdir" >&$verbose
+		echo $srcdir/devtools/gen-abi.sh \
+			$(readlink -f $builds_dir/$targetdir/install) >&$veryverbose
 		$srcdir/devtools/gen-abi.sh \
-			$(readlink -f $builds_dir/$targetdir/install)
+			$(readlink -f $builds_dir/$targetdir/install) >&$veryverbose
+		echo $srcdir/devtools/check-abi.sh $abirefdir/$targetdir \
+			$(readlink -f $builds_dir/$targetdir/install) >&$veryverbose
 		$srcdir/devtools/check-abi.sh $abirefdir/$targetdir \
-			$(readlink -f $builds_dir/$targetdir/install)
+			$(readlink -f $builds_dir/$targetdir/install) >&$verbose
 	fi
 }
 
Signature · 1 line
2.29.2
author Applied
#5 lore raw

17/12/2020 10:05, Thomas Monjalon:

Quoted 9 lines

The scripts gen-abi.sh and check-abi.sh are updated
to print error messages to stderr so they are likely never ignored.

When called from test-meson-builds.sh, the standard messages on stdout can be more quiet depending on the verbosity settings.
The beginning of the ABI check is announced in verbose mode. The commands are printed in very verbose mode.
The check result details are available in verbose mode.

Quoted 3 lines

---
v2: remove abidiff command from stdout (already printed on error)

Applied