Mon Jun 25 09:38:46 2018 UTC ()
Rephrase the documentation of MKSANITIZER

Based on the feedback from <f8l> and <pgoyette>.


(kamil)
diff -r1.376 -r1.377 src/share/mk/bsd.README
cvs diff -r1.376 -r1.377 src/share/mk/bsd.README (expand / switch to unified diff)

--- src/share/mk/bsd.README 2018/06/24 20:40:58 1.376
+++ src/share/mk/bsd.README 2018/06/25 09:38:46 1.377
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1# $NetBSD: bsd.README,v 1.376 2018/06/24 20:40:58 kamil Exp $ 1# $NetBSD: bsd.README,v 1.377 2018/06/25 09:38:46 kamil Exp $
2# @(#)bsd.README 8.2 (Berkeley) 4/2/94 2# @(#)bsd.README 8.2 (Berkeley) 4/2/94
3 3
4This is the README file for the make "include" files for the NetBSD 4This is the README file for the make "include" files for the NetBSD
5source tree. The files are installed in /usr/share/mk, and are, 5source tree. The files are installed in /usr/share/mk, and are,
6by convention, named with the suffix ".mk". 6by convention, named with the suffix ".mk".
7 7
8Note, this file is not intended to replace reading through the .mk 8Note, this file is not intended to replace reading through the .mk
9files for anything tricky. 9files for anything tricky.
10 10
11=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 11=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
12 12
13RANDOM THINGS WORTH KNOWING: 13RANDOM THINGS WORTH KNOWING:
14 14
@@ -382,40 +382,39 @@ MKRELRO If "partial", set the non-PLT G @@ -382,40 +382,39 @@ MKRELRO If "partial", set the non-PLT G
382 also force immediate symbol binding. 382 also force immediate symbol binding.
383 Default: no 383 Default: no
384  384
385MKREPRO If "yes", create reproducible builds. This enables 385MKREPRO If "yes", create reproducible builds. This enables
386 different switches to make two builds from the same source tree 386 different switches to make two builds from the same source tree
387 result in the same build results. 387 result in the same build results.
388 Default: no 388 Default: no
389 389
390MKSANITIZER if "yes", use the selected sanitizer to compile userland 390MKSANITIZER if "yes", use the selected sanitizer to compile userland
391 programs as defined in USE_SANITIZER, which defaults to 391 programs as defined in USE_SANITIZER, which defaults to
392 "address". A selection of available sanitizers: 392 "address". A selection of available sanitizers:
393 address: A memory error detector (default) 393 address: A memory error detector (default)
394 thread: A data race detector 394 thread: A data race detector
395 memory: An uninitializer read detector 395 memory: An uninitialized memory read detector
396 undefined: An undefined behavior detector 396 undefined: An undefined behavior detector
397 leak: A memory leak detector 397 leak: A memory leak detector
398 dataflow: A general data flow analysis 398 dataflow: A general data flow analysis
399 cfi: A control flow detector 399 cfi: A control flow detector
400 safe-stack: Protect against stack-based corruption 400 safe-stack: Protect against stack-based corruption
401 scudo: The Scudo Hardened allocator 401 scudo: The Scudo Hardened allocator
402 It's possible to specify multiple sanitizers within the 402 It's possible to specify multiple sanitizers within the
403 USE_SANITIZER option (comma separated) and some combinations of 403 USE_SANITIZER option (comma separated). The USE_SANITIZER value
404 them work. The USE_SANITIZER value is passed to the -fsanitize= 404 is passed to the -fsanitize= argument to the compiler.
405 argument to a compiler. 
406 Additional arguments can be passed through SANITIZERFLAGS. 405 Additional arguments can be passed through SANITIZERFLAGS.
407 The list of supported features depends on the compiler version 406 The list of supported features and their valid combinations
408 and target CPU architecture. 407 depends on the compiler version and target CPU architecture.
409 408
410MKSHARE If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no 409MKSHARE If "no", act as "MKCATPAGES=no MKDOC=no MKHTML=no MKINFO=no
411 MKMAN=no MKNLS=no". 410 MKMAN=no MKNLS=no".
412 I.e, don't build catman pages, documentation, Info 411 I.e, don't build catman pages, documentation, Info
413 documentation, man pages, NLS files, ... 412 documentation, man pages, NLS files, ...
414 Default: yes 413 Default: yes
415 414
416MKSKEY If "no", disables building of S/key authentication 415MKSKEY If "no", disables building of S/key authentication
417 infrastructure (libraries and support programs). 416 infrastructure (libraries and support programs).
418 Default: yes 417 Default: yes
419 418
420MKSLJIT If "no", disables building of sljit (stack-less platform 419MKSLJIT If "no", disables building of sljit (stack-less platform
421 independent JIT compiler) private library and tests. 420 independent JIT compiler) private library and tests.