summaryrefslogtreecommitdiffstats
path: root/share/man/man9/CTASSERT.9
diff options
context:
space:
mode:
authoremaste <emaste@FreeBSD.org>2008-09-05 15:24:54 +0000
committeremaste <emaste@FreeBSD.org>2008-09-05 15:24:54 +0000
commit9badf4bdbee1b45086f9430940ce408ec11608d2 (patch)
tree73d7c884f022b90d49a3a8fc174e82c0b3e611a9 /share/man/man9/CTASSERT.9
parente690e2f8cd7310c4c8f1adedc3dfd2ef7ff3b045 (diff)
downloadFreeBSD-src-9badf4bdbee1b45086f9430940ce408ec11608d2.zip
FreeBSD-src-9badf4bdbee1b45086f9430940ce408ec11608d2.tar.gz
Add a note that CTASSERT() should not be used in header files.
Diffstat (limited to 'share/man/man9/CTASSERT.9')
-rw-r--r--share/man/man9/CTASSERT.910
1 files changed, 9 insertions, 1 deletions
diff --git a/share/man/man9/CTASSERT.9 b/share/man/man9/CTASSERT.9
index 5c9d30e..db1ad49 100644
--- a/share/man/man9/CTASSERT.9
+++ b/share/man/man9/CTASSERT.9
@@ -26,7 +26,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd May 15, 2003
+.Dd September 5, 2008
.Os
.Dt CTASSERT 9
.Sh NAME
@@ -48,6 +48,14 @@ The
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 IMPLEMENTATION NOTES
+The
+.Fn CTASSERT
+macro should not be used in a header file.
+It is implemented using a dummy typedef, with a name (based on line number)
+that may conflict with a
+.Fn CTASSERT
+in a source file including that header.
.Sh EXAMPLES
Assert that the size of the
.Vt uuid
OpenPOWER on IntegriCloud