diff options
author | Peter Tribble <peter.tribble@gmail.com> | 2021-06-21 19:27:33 +0100 |
---|---|---|
committer | Peter Tribble <peter.tribble@gmail.com> | 2021-06-22 19:23:45 +0100 |
commit | c432de9c6e1189ea0aa9b0fe1c35c18427653f27 (patch) | |
tree | f224755b67a1e348f953d5a1132f7d4b64cf4a63 /usr/src/man/man3ext | |
parent | 0b9a51588b7231474f7b4009cb9cad83e4db7b74 (diff) | |
download | illumos-joyent-c432de9c6e1189ea0aa9b0fe1c35c18427653f27.tar.gz |
13883 Malformed #include statements in the manual
Reviewed by: Toomas Soome <tsoome@me.com>
Reviewed by: Andy Fiddaman <andy@omnios.org>
Reviewed by: Richard Lowe <richlowe@richlowe.net>
Approved by: Dan McDonald <danmcd@joyent.com>
Diffstat (limited to 'usr/src/man/man3ext')
-rw-r--r-- | usr/src/man/man3ext/NOTE.3ext | 15 |
1 files changed, 2 insertions, 13 deletions
diff --git a/usr/src/man/man3ext/NOTE.3ext b/usr/src/man/man3ext/NOTE.3ext index f858dd9d19..acf8c8234b 100644 --- a/usr/src/man/man3ext/NOTE.3ext +++ b/usr/src/man/man3ext/NOTE.3ext @@ -3,11 +3,10 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH NOTE 3EXT "Dec 31, 1996" +.TH NOTE 3EXT "June 18, 2021" .SH NAME NOTE, _NOTE \- annotate source code with info for tools .SH SYNOPSIS -.LP .nf #include <note.h> @@ -19,7 +18,7 @@ NOTE, _NOTE \- annotate source code with info for tools .LP .nf or -#include<sys/note.h> +#include <sys/note.h> @@ -27,8 +26,6 @@ or .fi .SH DESCRIPTION -.sp -.LP These macros are used to embed information for tools in program source. A use of one of these macros is called an "annotation". A tool may define a set of such annotations which can then be used to provide the tool with information @@ -101,8 +98,6 @@ particular type of annotation may only be allowed in a subset of those places. For example, a particular annotation may not be allowed inside a \fBstruct\fR or \fBunion\fR definition. .SS "NOTE vs _NOTE" -.sp -.LP Ordinarily, \fBNOTE\fR should be used rather than \fB_NOTE\fR, since use of \fB_NOTE\fR technically makes a program non-portable. However, it may be inconvenient to use \fBNOTE\fR for this purpose in existing code if \fBNOTE\fR @@ -127,8 +122,6 @@ Public header files which span projects should use \fB_NOTE\fR rather than \fBNOTE\fR, since \fBNOTE\fR may already be used by a program which needs to include such a header file. .SS "\fINoteInfo\fR\fB Argument\fR" -.sp -.LP The actual \fINoteInfo\fR used in an annotation should be specified by a tool that deals with program source (see the documentation for the tool to determine which annotations, if any, it understands). @@ -152,8 +145,6 @@ be compatible with an ANSI C tokenizer and that unquoted parentheses be balanced (so that the end of the annotation can be determined without intimate knowledge of any particular annotation). .SH ATTRIBUTES -.sp -.LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -168,6 +159,4 @@ MT-Level Safe .TE .SH SEE ALSO -.sp -.LP \fBnote\fR(4), \fBattributes\fR(5) |