aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Johnston <markj@FreeBSD.org>2021-04-29 16:26:03 +0000
committerMark Johnston <markj@FreeBSD.org>2021-04-29 16:26:37 +0000
commit420d30f5bdbfc20d83b3c9a7d5b4e90446b922fa (patch)
tree0a3a5204b67ec22b6a4bf67c02235f070edd855d
parent20e3b9d8bd778445bb80b2be28d2fdedf7bae37e (diff)
downloadsrc-420d30f5bdbfc20d83b3c9a7d5b4e90446b922fa.tar.gz
src-420d30f5bdbfc20d83b3c9a7d5b4e90446b922fa.zip
kasan.9: A couple of fixups
- Mention GENERIC-KASAN. - Note that the runtime was ported from NetBSD. Sponsored by: The FreeBSD Foundation
-rw-r--r--share/man/man9/kasan.922
1 files changed, 16 insertions, 6 deletions
diff --git a/share/man/man9/kasan.9 b/share/man/man9/kasan.9
index ecc068209913..d675a78f1e29 100644
--- a/share/man/man9/kasan.9
+++ b/share/man/man9/kasan.9
@@ -27,15 +27,22 @@
.\"
.\" $FreeBSD$
.\"
-.Dd April 13, 2021
+.Dd April 29, 2021
.Dt KASAN 9
.Os
.Sh NAME
-.Nm kasan
-.Nd kernel address sanitizer
+.Nm KASAN
+.Nd Kernel Address SANitizer
.Sh SYNOPSIS
-To compile KASAN into the kernel, place the following line in your kernel
-configuration file:
+The
+.Pa GENERIC-KASAN
+kernel configuration can be used to compile a KASAN-enabled kernel using
+.Pa GENERIC
+as a base configuration.
+Alternately, to compile
+.Nm
+into the kernel, place the following line in your
+kernel configuration file:
.Bd -ragged -offset indent
.Cd "options KASAN"
.Ed
@@ -142,13 +149,16 @@ are equal,
.Fa code
should be 0.
.Sh SEE ALSO
+.Xr build 7 ,
.Xr malloc 9 ,
.Xr memguard 9 ,
.Xr redzone 9 ,
.Xr uma 9
.Sh HISTORY
.Nm
-first appeared in
+was ported from
+.Nx
+and first appeared in
.Fx 14.0 .
.Sh BUGS
Accesses to kernel memory outside of the kernel map are ignored by the