d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
30b39270d0
freebsd-dev/share/man/man9/KASSERT.9

76 lines
2.2 KiB
Groff
Raw Normal View History

Document the KASSERT() macro.
2000-01-14 21:41:09 +00:00
.\" -*- nroff -*-
.\"
Assorted bag o' fixes: fix Jonathan's name, fix copyright date, man -> manual, add const before char *msg, add email address.
2000-03-21 13:18:40 +00:00
.\" Copyright (c) 2000 Jonathan M. Bresler
Document the KASSERT() macro.
2000-01-14 21:41:09 +00:00
.\"
.\" All rights reserved.
.\"
.\" This program is free software.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd January 14, 2000
.Os
.Dt KASSERT 9
.Sh NAME
.Nm KASSERT
.Nd kernel expression verification macro
.Sh SYNOPSIS
Assorted bag o' fixes: fix Jonathan's name, fix copyright date, man -> manual, add const before char *msg, add email address.
2000-03-21 13:18:40 +00:00
.Cd options INVARIANTS
Abuse .Fn for macros better (don't hand-format the parameter string by quoting it all and adding commas). Don't say that the expression in KASSERT() is an int. It is a collection of tokens forming a C expression that can be compared with 0.
2000-05-11 16:54:52 +00:00
.Fn KASSERT expression "const char *msg"
Document the KASSERT() macro.
2000-01-14 21:41:09 +00:00
.Sh DESCRIPTION
In a kernel compiled with "options INVARIANTS",
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days
2001-07-14 19:41:16 +00:00
the
Document the KASSERT() macro.
2000-01-14 21:41:09 +00:00
.Fn KASSERT
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days
2001-07-14 19:41:16 +00:00
macro tests the given
Document the KASSERT() macro.
2000-01-14 21:41:09 +00:00
.Ar expression
and if it is false,
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days
2001-07-14 19:41:16 +00:00
calls the
Document the KASSERT() macro.
2000-01-14 21:41:09 +00:00
.Fn panic
syscall, terminating the running system.
.Pp
In a kernel that does not have "options INVARIANTS",
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days
2001-07-14 19:41:16 +00:00
the
Document the KASSERT() macro.
2000-01-14 21:41:09 +00:00
.Fn KASSERT
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days
2001-07-14 19:41:16 +00:00
macro is defined to be a no-op.
Fix EXAMPLE -> EXAMPLES. Add Xr's for SPLASSERT and CONDSPLASSERT.
2000-03-21 13:21:36 +00:00
.Sh EXAMPLES
Document the KASSERT() macro.
2000-01-14 21:41:09 +00:00
The kernel function
.Fn vput
must not be called with a NULL pointer.
.Bd -literal -offset indent
void
vput(vp)
struct vnode *vp;
{
struct proc *p = curproc;
KASSERT(vp != NULL, ("vput: null vp"));
...
}
.Ed
.Sh SEE ALSO
.Xr config 8 ,
Remove trailing comma.
2000-03-21 17:34:56 +00:00
.Xr panic 9
Document the KASSERT() macro.
2000-01-14 21:41:09 +00:00
.Sh AUTHORS
Assorted bag o' fixes: fix Jonathan's name, fix copyright date, man -> manual, add const before char *msg, add email address.
2000-03-21 13:18:40 +00:00
This manual page was written by
.An Jonathan M. Bresler
Minor style fixes: freebsd.org -> FreeBSD.org
2000-03-24 01:49:46 +00:00
.Aq jmb@FreeBSD.org .
Reference in New Issue Copy Permalink