diff options
| -rw-r--r-- | share/man/man9/CTASSERT.9 | 64 | ||||
| -rw-r--r-- | share/man/man9/Makefile | 2 |
2 files changed, 65 insertions, 1 deletions
diff --git a/share/man/man9/CTASSERT.9 b/share/man/man9/CTASSERT.9 new file mode 100644 index 0000000..c3e29a2 --- /dev/null +++ b/share/man/man9/CTASSERT.9 @@ -0,0 +1,64 @@ +.\" Copyright (c) 2003 Hiten M. Pandya +.\" +.\" 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 May 15, 2003 +.Os +.Dt CTASSERT 9 +.Sh NAME +.Nm CTASSERT +.Nd compile time assertion macro +.Sh SYNOPSIS +.Pp +.In sys/param.h +.In sys/systm.h +.Fn CTASSERT expression +.Sh DESCRIPTION +The +.Nm +macro evaluates +.Fa expression +at compile time and causes a compiler error if it is false. +.Pp +The +.Nm +macro is useful for asserting the size or alignment of important +data structures and variables during compilation, which would +otherwise cause the code to fail at run time. +.Sh EXAMPLES +Assert that the size of the +.Vt uuid +structure is 16 bytes. +.Bd -literal -offset indent +CTASSERT(sizeof(struct uuid) == 16); +.Ed +.Sh SEE ALSO +.Xr KASSERT 9 +.Sh AUTHORS +This manual page was written by +.An Hiten M. Pandya +.Aq hmp@FreeBSD.ORG . diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile index ccb75bb..c748bef 100644 --- a/share/man/man9/Makefile +++ b/share/man/man9/Makefile @@ -6,7 +6,7 @@ MAN= BUF_LOCK.9 BUF_LOCKFREE.9 BUF_LOCKINIT.9 BUF_REFCNT.9 \ DECLARE_MODULE.9 DELAY.9 DEVICE_ATTACH.9 DEVICE_DETACH.9 \ DEVICE_IDENTIFY.9 DEVICE_PROBE.9 DEVICE_SHUTDOWN.9 \ DEV_MODULE.9 DRIVER_MODULE.9 \ - KASSERT.9 \ + CTASSERT.9 KASSERT.9 \ MD5.9 MODULE_DEPEND.9 MODULE_VERSION.9 \ SYSCALL_MODULE.9 \ VFS.9 VFS_CHECKEXP.9 VFS_FHTOVP.9 VFS_INIT.9 VFS_MOUNT.9 \ |
