share/man/man4/note.4

   1 '\" te
   2 .\" Copyright (c) 1995, Sun Microsystems, Inc.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH NOTE 4 "Jan 17, 1995"
   7 .SH NAME
   8 note \- specify legal annotations
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/lib/note\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 Each file in this directory contains the \fBNOTE\fR (also \fB_NOTE\fR)
  19 annotations legal for a single tool.  The name of the file, by convention,
  20 should be the tool vendor's stock name, followed by a hyphen, followed by the
  21 tool name. For example, for Sun's \fBlock_lint\fR tool the filename should be
  22 \fBSUNW-lock_lint\fR.
  23 .sp
  24 .LP
  25 The file should contain the names of the annotations understood by the tool,
  26 one per line.  For example, if a tool understands the following annotations:
  27 .sp
  28 .in +2
  29 .nf
  30 NOTE(NOT_REACHED)
  31 NOTE(MUTEX_PROTECTS_DATA(list_lock, list_head))
  32 .fi
  33 .in -2
  34 .sp
  35
  36 .sp
  37 .LP
  38 then its file in \fB/usr/lib/note\fR should contain the entries:
  39 .sp
  40 .in +2
  41 .nf
  42 \fBNOT_REACHED
  43 MUTEX_PROTECTS_DATA\fR
  44 .fi
  45 .in -2
  46 .sp
  47
  48 .sp
  49 .LP
  50 Blank lines, and lines beginning with a pound (#), are ignored.
  51 .sp
  52 .LP
  53 While \fB/usr/lib/note\fR is the default directory tools search for such files,
  54 they can be made to search other directories instead simply by setting
  55 environment variable \fBNOTE\fR\fBPATH\fR to contain the paths, separated by
  56 colons, of directories to be searched, e.g.,
  57 \fB/usr/mytool/note:/usr/lib/note\fR.
  58 .SH USAGE
  59 .sp
  60 .LP
  61 These files are used by such tools whenever they encounter \fBNOTE\fRs they do
  62 not understand.  If a file in \fB/usr/lib/note\fR contains the annotation, then
  63 it is valid. If no such file contains the annotation, then the tool should
  64 issue a warning complaining that it might be invalid.
  65 .SH ENVIRONMENT VARIABLES
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBNOTE\fR\fBPATH\fR\fR
  70 .ad
  71 .RS 12n
  72 specify paths to be searched for annotation files. Paths are separated by
  73 colons (":").
  74 .RE
  75
  76 .SH SEE ALSO
  77 .sp
  78 .LP
  79 \fBNOTE\fR(3EXT)