Add a note that CTASSERT() should not be used in header files.
This commit is contained in:
parent
e690e2f8cd
commit
9badf4bdbe
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user