CPU_SET.3: NOTES: Discuss use of types in "prototypes" for these macros

The SYNOPSIS shows types for arguments and return values, but
these are really just suggestions: since the interfaces are
macros, the compiler won't catch all violations of
the "type rules".  Warn the reader of this.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2008-11-14 11:57:50 -05:00
parent 6ee1c2aaf5
commit f4efb1e28b
1 changed files with 6 additions and 0 deletions

View File

@ -284,6 +284,12 @@ while the
argument of the
.BR CPU_*_S ()
macros is a size in bytes.
The data types for arguments and return values shown
in the SYNOPSIS are hints what about is expected in each case.
However, since these these interfaces are implemented as macros,
the compiler won't necessarily catch all type errors
if you violate the suggestions.
.SH EXAMPLE
The following program demonstrates the use of some of the macros
used for dynamically allocated CPU sets.