xref: /illumos-gate/usr/src/uts/common/sys/note.h (revision fafb665d)
1*7c478bd9Sstevel@tonic-gate /*
2*7c478bd9Sstevel@tonic-gate  * CDDL HEADER START
3*7c478bd9Sstevel@tonic-gate  *
4*7c478bd9Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*7c478bd9Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*7c478bd9Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*7c478bd9Sstevel@tonic-gate  * with the License.
8*7c478bd9Sstevel@tonic-gate  *
9*7c478bd9Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*7c478bd9Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*7c478bd9Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*7c478bd9Sstevel@tonic-gate  * and limitations under the License.
13*7c478bd9Sstevel@tonic-gate  *
14*7c478bd9Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*7c478bd9Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*7c478bd9Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*7c478bd9Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*7c478bd9Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*7c478bd9Sstevel@tonic-gate  *
20*7c478bd9Sstevel@tonic-gate  * CDDL HEADER END
21*7c478bd9Sstevel@tonic-gate  */
22*7c478bd9Sstevel@tonic-gate /*
23*7c478bd9Sstevel@tonic-gate  * Copyright (c) 1994 by Sun Microsystems, Inc.
24*7c478bd9Sstevel@tonic-gate  */
26*7c478bd9Sstevel@tonic-gate /*
27*7c478bd9Sstevel@tonic-gate  * sys/note.h:	interface for annotating source with info for tools
28*7c478bd9Sstevel@tonic-gate  *
29*7c478bd9Sstevel@tonic-gate  * This is the underlying interface; NOTE (/usr/include/note.h) is the
30*7c478bd9Sstevel@tonic-gate  * preferred interface, but all exported header files should include this
31*7c478bd9Sstevel@tonic-gate  * file directly and use _NOTE so as not to take "NOTE" from the user's
32*7c478bd9Sstevel@tonic-gate  * namespace.  For consistency, *all* kernel source should use _NOTE.
33*7c478bd9Sstevel@tonic-gate  *
34*7c478bd9Sstevel@tonic-gate  * By default, annotations expand to nothing.  This file implements
35*7c478bd9Sstevel@tonic-gate  * that.  Tools using annotations will interpose a different version
36*7c478bd9Sstevel@tonic-gate  * of this file that will expand annotations as needed.
37*7c478bd9Sstevel@tonic-gate  */
39*7c478bd9Sstevel@tonic-gate #ifndef	_SYS_NOTE_H
40*7c478bd9Sstevel@tonic-gate #define	_SYS_NOTE_H
42*7c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
43*7c478bd9Sstevel@tonic-gate extern "C" {
44*7c478bd9Sstevel@tonic-gate #endif
46*7c478bd9Sstevel@tonic-gate #ifndef _NOTE
47*7c478bd9Sstevel@tonic-gate #define	_NOTE(s)
48*7c478bd9Sstevel@tonic-gate #endif
50*7c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
51*7c478bd9Sstevel@tonic-gate }
52*7c478bd9Sstevel@tonic-gate #endif
54*7c478bd9Sstevel@tonic-gate #endif	/* _SYS_NOTE_H */