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