diff options
author | ru <ru@FreeBSD.org> | 2002-01-10 09:20:07 +0000 |
---|---|---|
committer | ru <ru@FreeBSD.org> | 2002-01-10 09:20:07 +0000 |
commit | a439fcb2616ba17a43fa87734142ac75a97b7431 (patch) | |
tree | 76149f488695ac2637e07d1faa6d92ef4abc97a1 | |
parent | f17c6ab9a7494d051eab0f891a1f2544682453f7 (diff) | |
download | FreeBSD-src-a439fcb2616ba17a43fa87734142ac75a97b7431.zip FreeBSD-src-a439fcb2616ba17a43fa87734142ac75a97b7431.tar.gz |
mdoc(7) police:
- logically sort the SYNOPSIS section
- add missing markup bits
- "brackets" -> "parentheses"
-rw-r--r-- | share/man/man9/KASSERT.9 | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/share/man/man9/KASSERT.9 b/share/man/man9/KASSERT.9 index 88797ca..4be501f 100644 --- a/share/man/man9/KASSERT.9 +++ b/share/man/man9/KASSERT.9 @@ -35,29 +35,34 @@ .Nm KASSERT .Nd kernel expression verification macro .Sh SYNOPSIS +.Cd "options INVARIANTS" +.Pp .In sys/param.h .In sys/systm.h -.Cd options INVARIANTS .Fn KASSERT expression msg .Sh DESCRIPTION -In a kernel compiled with "options INVARIANTS", +In a kernel compiled with +.Cd "options INVARIANTS" , the .Fn KASSERT macro tests the given -.Ar expression +.Fa expression and if it is false, calls the -.Fn panic -syscall, terminating the running system. +.Xr panic 9 +function, terminating the running system. .Pp -In a kernel that does not have "options INVARIANTS", +In a kernel that does not have +.Cd "options INVARIANTS" , the .Fn KASSERT macro is defined to be a no-op. .Sh EXAMPLES The kernel function .Fn vput -must not be called with a NULL pointer. +must not be called with a +.Dv NULL +pointer. .Bd -literal -offset indent void vput(vp) @@ -70,7 +75,7 @@ vput(vp) .Ed .Sh NOTES .Fa msg -must be enclosed in brackets. +must be enclosed in parentheses. .Sh SEE ALSO .Xr config 8 , .Xr panic 9 |