1note(4)                          File Formats                          note(4)
2
3
4

NAME

6       note - specify legal annotations
7

SYNOPSIS

9       /usr/lib/note
10
11

DESCRIPTION

13       Each  file in this directory contains the NOTE (also _NOTE) annotations
14       legal for a single tool.  The name of the file, by  convention,  should
15       be  the tool vendor's stock name, followed by a hyphen, followed by the
16       tool name. For example, for Sun's lock_lint tool the filename should be
17       SUNW-lock_lint.
18
19
20       The  file should contain the names of the annotations understood by the
21       tool, one per line.  For example, if a tool understands  the  following
22       annotations:
23
24         NOTE(NOT_REACHED)
25         NOTE(MUTEX_PROTECTS_DATA(list_lock, list_head))
26
27
28
29
30       then its file in /usr/lib/note should contain the entries:
31
32         NOT_REACHED
33         MUTEX_PROTECTS_DATA
34
35
36
37
38       Blank lines, and lines beginning with a pound (#), are ignored.
39
40
41       While  /usr/lib/note  is  the  default  directory tools search for such
42       files, they can be made to search other directories instead  simply  by
43       setting  environment  variable NOTEPATH to contain the paths, separated
44       by    colons,    of    directories    to     be     searched,     e.g.,
45       /usr/mytool/note:/usr/lib/note.
46

USAGE

48       These  files  are used by such tools whenever they encounter NOTEs they
49       do not understand.  If a file in /usr/lib/note contains the annotation,
50       then  it  is  valid.  If no such file contains the annotation, then the
51       tool should issue a warning complaining that it might be invalid.
52

ENVIRONMENT VARIABLES

54       NOTEPATH    specify paths to be searched for  annotation  files.  Paths
55                   are separated by colons (":").
56
57

SEE ALSO

59       NOTE(3EXT)
60
61
62
63SunOS 5.11                        17 Jan 1995                          note(4)