Module Name:    src
Committed By:   kamil
Date:           Sun Jun 24 20:40:58 UTC 2018

Modified Files:
        src/share/mk: bsd.README

Log Message:
Enhance the documentation of MKSANITIZER in bsd.README

Note that the list of sanitizer features is just a selection, not a
complete list. Include there LSan and Scudo. Missing: hwmsan, esan,
ubsan_minimal etc.

Explain that USE_SANITIZER is an argument passed to -fsanitize= and it can
contain multiple options.

Mention SANITIZERFLAGS to pass even more sanitizer arguments.

Stop tracking in this file what compiler compiles what features. Just note
that the selection of supported features depends on a compiler version and
target CPU architecture.


To generate a diff of this commit:
cvs rdiff -u -r1.375 -r1.376 src/share/mk/bsd.README

Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.

Modified files:

Index: src/share/mk/bsd.README
diff -u src/share/mk/bsd.README:1.375 src/share/mk/bsd.README:1.376
--- src/share/mk/bsd.README:1.375	Sun Jun  3 04:41:04 2018
+++ src/share/mk/bsd.README	Sun Jun 24 20:40:58 2018
@@ -1,4 +1,4 @@
-#	$NetBSD: bsd.README,v 1.375 2018/06/03 04:41:04 wiz Exp $
+#	$NetBSD: bsd.README,v 1.376 2018/06/24 20:40:58 kamil Exp $
 #	@(#)bsd.README	8.2 (Berkeley) 4/2/94
 
 This is the README file for the make "include" files for the NetBSD
@@ -389,15 +389,23 @@ MKREPRO         If "yes", create reprodu
 
 MKSANITIZER	if "yes", use the selected sanitizer to compile userland
 		programs as defined in USE_SANITIZER, which defaults to
-		"address". Available sanitizers are:
+		"address". A selection of available sanitizers:
 			address:	A memory error detector (default)
 			thread:		A data race detector
 			memory:		An uninitializer read detector
 			undefined:	An undefined behavior detector
+			leak:		A memory leak detector
 			dataflow:	A general data flow analysis
 			cfi:		A control flow detector
 			safe-stack:	Protect against stack-based corruption
-		Only "address" is currently available for gcc(1).
+			scudo:		The Scudo Hardened allocator
+		It's possible to specify multiple sanitizers within the
+		USE_SANITIZER option (comma separated) and some combinations of
+		them work. The USE_SANITIZER value is passed to the -fsanitize=
+		argument to a compiler.
+		Additional arguments can be passed through SANITIZERFLAGS.
+		The list of supported features depends on the compiler version
+		and target CPU architecture.
 
 MKSHARE		If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
 		MKMAN=no MKNLS=no".

Reply via email to