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