xref: /freebsd-src/cddl/contrib/opensolaris/head/note.h (revision d876124d6ae9d56da5b4ff4c6015efd1d0c9222a)
1*d876124dSJohn Birrell /*
2*d876124dSJohn Birrell  * CDDL HEADER START
3*d876124dSJohn Birrell  *
4*d876124dSJohn Birrell  * The contents of this file are subject to the terms of the
5*d876124dSJohn Birrell  * Common Development and Distribution License, Version 1.0 only
6*d876124dSJohn Birrell  * (the "License").  You may not use this file except in compliance
7*d876124dSJohn Birrell  * with the License.
8*d876124dSJohn Birrell  *
9*d876124dSJohn Birrell  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*d876124dSJohn Birrell  * or http://www.opensolaris.org/os/licensing.
11*d876124dSJohn Birrell  * See the License for the specific language governing permissions
12*d876124dSJohn Birrell  * and limitations under the License.
13*d876124dSJohn Birrell  *
14*d876124dSJohn Birrell  * When distributing Covered Code, include this CDDL HEADER in each
15*d876124dSJohn Birrell  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*d876124dSJohn Birrell  * If applicable, add the following below this CDDL HEADER, with the
17*d876124dSJohn Birrell  * fields enclosed by brackets "[]" replaced with your own identifying
18*d876124dSJohn Birrell  * information: Portions Copyright [yyyy] [name of copyright owner]
19*d876124dSJohn Birrell  *
20*d876124dSJohn Birrell  * CDDL HEADER END
21*d876124dSJohn Birrell  */
22*d876124dSJohn Birrell /*
23*d876124dSJohn Birrell  * Copyright (c) 1994 by Sun Microsystems, Inc.
24*d876124dSJohn Birrell  */
25*d876124dSJohn Birrell 
26*d876124dSJohn Birrell /*
27*d876124dSJohn Birrell  * note.h:	interface for annotating source with info for tools
28*d876124dSJohn Birrell  *
29*d876124dSJohn Birrell  * NOTE is the default interface, but if the identifier NOTE is in use for
30*d876124dSJohn Birrell  * some other purpose, you may prepare a similar header file using your own
31*d876124dSJohn Birrell  * identifier, mapping that identifier to _NOTE.  Also, exported header
32*d876124dSJohn Birrell  * files should *not* use NOTE, since the name may already be in use in
33*d876124dSJohn Birrell  * a program's namespace.  Rather, exported header files should include
34*d876124dSJohn Birrell  * sys/note.h directly and use _NOTE.  For consistency, all kernel source
35*d876124dSJohn Birrell  * should use _NOTE.
36*d876124dSJohn Birrell  */
37*d876124dSJohn Birrell 
38*d876124dSJohn Birrell #ifndef	_NOTE_H
39*d876124dSJohn Birrell #define	_NOTE_H
40*d876124dSJohn Birrell 
41*d876124dSJohn Birrell #pragma ident	"%Z%%M%	%I%	%E% SMI"
42*d876124dSJohn Birrell 
43*d876124dSJohn Birrell #include <sys/note.h>
44*d876124dSJohn Birrell 
45*d876124dSJohn Birrell #ifdef	__cplusplus
46*d876124dSJohn Birrell extern "C" {
47*d876124dSJohn Birrell #endif
48*d876124dSJohn Birrell 
49*d876124dSJohn Birrell #define	NOTE _NOTE
50*d876124dSJohn Birrell 
51*d876124dSJohn Birrell #ifdef	__cplusplus
52*d876124dSJohn Birrell }
53*d876124dSJohn Birrell #endif
54*d876124dSJohn Birrell 
55*d876124dSJohn Birrell #endif	/* _NOTE_H */
56