From 9c778285ea0f099f968382d6c71dd2e9d522e7c7 Mon Sep 17 00:00:00 2001
From: Monty <monty@mariadb.org>
Date: Wed, 9 Jun 2021 14:44:13 +0300
Subject: Added comments to some BUILD scripts

---
 BUILD/compile-pentium64-asan-max | 7 ++++++-
 BUILD/compile-pentium64-ubsan    | 8 ++++++++
 2 files changed, 14 insertions(+), 1 deletion(-)

(limited to 'BUILD')

diff --git a/BUILD/compile-pentium64-asan-max b/BUILD/compile-pentium64-asan-max
index 37acc9f74f3..cedf5254e59 100755
--- a/BUILD/compile-pentium64-asan-max
+++ b/BUILD/compile-pentium64-asan-max
@@ -17,7 +17,12 @@
 path=`dirname $0`
 . "$path/SETUP.sh"
 
-extra_flags="$pentium64_cflags $debug_cflags -lasan -O -g -fsanitize=address -USAFEMALLOC -UFORCE_INIT_OF_VARS -Wno-uninitialized -Wno-maybe-uninitialized"
+#
+# Enable AddressSanitzer, a fast memory error detector.
+# Detects "Out of bounds" and "use-after-free" memory errors
+#
+
+extra_flags="$pentium64_cflags $debug_cflags -lasan -O -g -fsanitize=address -USAFEMALLOC -UFORCE_INIT_OF_VARS -Wno-uninitialized -Wno-maybe-uninitialized -DMYSQL_SERVER_SUFFIX=-asan-max"
 extra_configs="$pentium_configs $debug_configs $valgrind_configs $max_configs $disable_asan_plugins"
 export LDFLAGS="-ldl"
 
diff --git a/BUILD/compile-pentium64-ubsan b/BUILD/compile-pentium64-ubsan
index 1a2b45413b0..538b5e884cf 100755
--- a/BUILD/compile-pentium64-ubsan
+++ b/BUILD/compile-pentium64-ubsan
@@ -23,6 +23,14 @@
 path=`dirname $0`
 . "$path/SETUP.sh"
 
+#
+# Enable UBSAN, UndefinedBehaviorSanitizer. Detects undefined behavior like:
+# - Using misaligned or null pointer
+# - Signed integer overflow
+# - Conversion to, from, or between floating-point types which would overflow
+#   the destination
+#
+
 extra_flags="$pentium64_cflags $debug_cflags -fsanitize=undefined -DWITH_UBSAN -Wno-conversion -Wno-uninitialized"
 extra_configs="$pentium_configs $debug_configs -DWITH_UBSAN=ON -DMYSQL_MAINTAINER_MODE=NO --without-spider"
 
-- 
cgit v1.2.1