Blame


1 02f38ca6 2005-01-04 devnull # Usage: cd $PLAN9; awk -f dist/checkman.awk man?/*.?
2 02f38ca6 2005-01-04 devnull #
3 02f38ca6 2005-01-04 devnull # Checks:
4 02f38ca6 2005-01-04 devnull # - .TH is first line, and has proper name section number
5 02f38ca6 2005-01-04 devnull # - sections are in order NAME, SYNOPSIS, DESCRIPTION, EXAMPLES,
6 02f38ca6 2005-01-04 devnull # FILES, SOURCE, SEE ALSO, DIAGNOSTICS, BUGS
7 02f38ca6 2005-01-04 devnull # - there's a manual page for each cross-referenced page
8 02f38ca6 2005-01-04 devnull
9 02f38ca6 2005-01-04 devnull BEGIN {
10 02f38ca6 2005-01-04 devnull
11 02f38ca6 2005-01-04 devnull # .SH sections should come in the following order
12 02f38ca6 2005-01-04 devnull
13 02f38ca6 2005-01-04 devnull Weight["NAME"] = 1
14 02f38ca6 2005-01-04 devnull Weight["SYNOPSIS"] = 2
15 02f38ca6 2005-01-04 devnull Weight["DESCRIPTION"] = 4
16 02f38ca6 2005-01-04 devnull Weight["EXAMPLE"] = 8
17 02f38ca6 2005-01-04 devnull Weight["EXAMPLES"] = 16
18 02f38ca6 2005-01-04 devnull Weight["FILES"] = 32
19 02f38ca6 2005-01-04 devnull Weight["SOURCE"] = 64
20 02f38ca6 2005-01-04 devnull Weight["SEE ALSO"] = 128
21 02f38ca6 2005-01-04 devnull Weight["DIAGNOSTICS"] = 256
22 02f38ca6 2005-01-04 devnull Weight["SYSTEM CALLS"] = 512
23 02f38ca6 2005-01-04 devnull Weight["BUGS"] = 1024
24 02f38ca6 2005-01-04 devnull
25 02f38ca6 2005-01-04 devnull Skipdirs["CVS"] = 1
26 02f38ca6 2005-01-04 devnull
27 02f38ca6 2005-01-04 devnull # allow references to pages provded
28 02f38ca6 2005-01-04 devnull # by the underlying Unix system
29 02f38ca6 2005-01-04 devnull Omitman["awk(1)"] = 1
30 02f38ca6 2005-01-04 devnull Omitman["bash(1)"] = 1
31 02f38ca6 2005-01-04 devnull Omitman["chmod(1)"] = 1
32 02f38ca6 2005-01-04 devnull Omitman["compress(1)"] = 1
33 02f38ca6 2005-01-04 devnull Omitman["cp(1)"] = 1
34 02f38ca6 2005-01-04 devnull Omitman["egrep(1)"] = 1
35 02f38ca6 2005-01-04 devnull Omitman["gs(1)"] = 1
36 02f38ca6 2005-01-04 devnull Omitman["gv(1)"] = 1
37 02f38ca6 2005-01-04 devnull Omitman["lex(1)"] = 1
38 02f38ca6 2005-01-04 devnull Omitman["lp(1)"] = 1
39 02f38ca6 2005-01-04 devnull Omitman["lpr(1)"] = 1
40 02f38ca6 2005-01-04 devnull Omitman["mail(1)"] = 1
41 83c4506a 2005-02-11 devnull Omitman["make(1)"] = 1
42 02f38ca6 2005-01-04 devnull Omitman["nm(1)"] = 1
43 02f38ca6 2005-01-04 devnull Omitman["prof(1)"] = 1
44 02f38ca6 2005-01-04 devnull Omitman["pwd(1)"] = 1
45 c8b6342d 2005-01-13 devnull Omitman["qiv(1)"] = 1
46 02f38ca6 2005-01-04 devnull Omitman["sh(1)"] = 1
47 02f38ca6 2005-01-04 devnull Omitman["ssh(1)"] = 1
48 c8b6342d 2005-01-13 devnull Omitman["stty(1)"] = 1
49 02f38ca6 2005-01-04 devnull Omitman["tex(1)"] = 1
50 02f38ca6 2005-01-04 devnull Omitman["unutf(1)"] = 1
51 83c4506a 2005-02-11 devnull Omitman["vnc(1)"] = 1
52 02f38ca6 2005-01-04 devnull Omitman["xterm(1)"] = 1
53 02f38ca6 2005-01-04 devnull
54 02f38ca6 2005-01-04 devnull Omitman["access(2)"] = 1
55 02f38ca6 2005-01-04 devnull Omitman["brk(2)"] = 1
56 c8b6342d 2005-01-13 devnull Omitman["chdir(2)"] = 1
57 02f38ca6 2005-01-04 devnull Omitman["close(2)"] = 1
58 02f38ca6 2005-01-04 devnull Omitman["connect(2)"] = 1
59 02f38ca6 2005-01-04 devnull Omitman["fork(2)"] = 1
60 02f38ca6 2005-01-04 devnull Omitman["gethostname(2)"] = 1
61 02f38ca6 2005-01-04 devnull Omitman["getpid(2)"] = 1
62 02f38ca6 2005-01-04 devnull Omitman["getuid(2)"] = 1
63 02f38ca6 2005-01-04 devnull Omitman["open(2)"] = 1
64 02f38ca6 2005-01-04 devnull Omitman["pipe(2)"] = 1
65 02f38ca6 2005-01-04 devnull Omitman["ptrace(2)"] = 1
66 02f38ca6 2005-01-04 devnull Omitman["rmdir(2)"] = 1
67 02f38ca6 2005-01-04 devnull Omitman["send(2)"] = 1
68 02f38ca6 2005-01-04 devnull Omitman["signal(2)"] = 1
69 02f38ca6 2005-01-04 devnull Omitman["sigprocmask(2)"] = 1
70 02f38ca6 2005-01-04 devnull Omitman["socketpair(2)"] = 1
71 02f38ca6 2005-01-04 devnull Omitman["unlink(2)"] = 1
72 02f38ca6 2005-01-04 devnull
73 02f38ca6 2005-01-04 devnull Omitman["abort(3)"] = 1
74 02f38ca6 2005-01-04 devnull Omitman["assert(3)"] = 1
75 02f38ca6 2005-01-04 devnull Omitman["fprintf(3)"] = 1
76 02f38ca6 2005-01-04 devnull Omitman["fscanf(3)"] = 1
77 02f38ca6 2005-01-04 devnull Omitman["fopen(3)"] = 1
78 02f38ca6 2005-01-04 devnull Omitman["isalpha(3)"] = 1
79 02f38ca6 2005-01-04 devnull Omitman["malloc(3)"] = 1
80 02f38ca6 2005-01-04 devnull Omitman["perror(3)"] = 1
81 02f38ca6 2005-01-04 devnull Omitman["remove(3)"] = 1
82 02f38ca6 2005-01-04 devnull Omitman["sin(3)"] = 1
83 02f38ca6 2005-01-04 devnull Omitman["strerror(3)"] = 1
84 02f38ca6 2005-01-04 devnull
85 02f38ca6 2005-01-04 devnull Omitman["core(5)"] = 1
86 02f38ca6 2005-01-04 devnull Omitman["passwd(5)"] = 1
87 02f38ca6 2005-01-04 devnull
88 02f38ca6 2005-01-04 devnull Omitman["signal(7)"] = 1
89 02f38ca6 2005-01-04 devnull
90 02f38ca6 2005-01-04 devnull Omitman["cron(8)"] = 1
91 02f38ca6 2005-01-04 devnull
92 02f38ca6 2005-01-04 devnull # don't need documentation for these in bin
93 02f38ca6 2005-01-04 devnull Omitted[".cvsignore"] = 1
94 02f38ca6 2005-01-04 devnull Omitted["Getdir"] = 1
95 83c4506a 2005-02-11 devnull Omitted["Irc"] = 1
96 83c4506a 2005-02-11 devnull Omitted["Juke"] = 1
97 83c4506a 2005-02-11 devnull Omitted["ajuke"] = 1
98 83c4506a 2005-02-11 devnull Omitted["goodmk"] = 1
99 83c4506a 2005-02-11 devnull Omitted["jukefmt"] = 1
100 83c4506a 2005-02-11 devnull Omitted["jukeget"] = 1
101 83c4506a 2005-02-11 devnull Omitted["jukeindex"] = 1
102 83c4506a 2005-02-11 devnull Omitted["jukeinfo"] = 1
103 83c4506a 2005-02-11 devnull Omitted["jukeplay"] = 1
104 83c4506a 2005-02-11 devnull Omitted["jukeput"] = 1
105 83c4506a 2005-02-11 devnull Omitted["jukesearch"] = 1
106 83c4506a 2005-02-11 devnull Omitted["jukesongfile"] = 1
107 83c4506a 2005-02-11 devnull Omitted["m4ainfo"] = 1
108 83c4506a 2005-02-11 devnull Omitted["mp3info"] = 1
109 83c4506a 2005-02-11 devnull Omitted["notes"] = 1
110 c8b6342d 2005-01-13 devnull Omitted["tcolors"] = 1
111 c8b6342d 2005-01-13 devnull Omitted["tref"] = 1
112 c8b6342d 2005-01-13 devnull Omitted["unutf"] = 1
113 83c4506a 2005-02-11 devnull Omitted["volume"] = 1
114 c8b6342d 2005-01-13 devnull Omitted["vtdump"] = 1
115 02f38ca6 2005-01-04 devnull
116 02f38ca6 2005-01-04 devnull # not for users
117 02f38ca6 2005-01-04 devnull Omittedlib["creadimage"] = 1
118 02f38ca6 2005-01-04 devnull Omittedlib["pixelbits"] = 1
119 02f38ca6 2005-01-04 devnull Omittedlib["bouncemouse"] = 1
120 02f38ca6 2005-01-04 devnull Omittedlib["main"] = 1 # in libthread
121 83c4506a 2005-02-11 devnull
122 83c4506a 2005-02-11 devnull Omittedlib["opasstokey"] = 1 # in libauthsrv
123 02f38ca6 2005-01-04 devnull
124 02f38ca6 2005-01-04 devnull # functions provided for -lthread_db
125 02f38ca6 2005-01-04 devnull Omittedlib["ps_get_thread_area"] = 1
126 02f38ca6 2005-01-04 devnull Omittedlib["ps_getpid"] = 1
127 02f38ca6 2005-01-04 devnull Omittedlib["ps_lcontinue"] = 1
128 02f38ca6 2005-01-04 devnull Omittedlib["ps_lgetfpregs"] = 1
129 02f38ca6 2005-01-04 devnull Omittedlib["ps_lgetregs"] = 1
130 02f38ca6 2005-01-04 devnull Omittedlib["ps_lsetfpregs"] = 1
131 02f38ca6 2005-01-04 devnull Omittedlib["ps_lsetregs"] = 1
132 02f38ca6 2005-01-04 devnull Omittedlib["ps_lstop"] = 1
133 02f38ca6 2005-01-04 devnull Omittedlib["ps_pcontinue"] = 1
134 02f38ca6 2005-01-04 devnull Omittedlib["ps_pdread"] = 1
135 02f38ca6 2005-01-04 devnull Omittedlib["ps_pdwrite"] = 1
136 02f38ca6 2005-01-04 devnull Omittedlib["ps_pglobal_lookup"] = 1
137 02f38ca6 2005-01-04 devnull Omittedlib["ps_pstop"] = 1
138 02f38ca6 2005-01-04 devnull Omittedlib["ps_ptread"] = 1
139 02f38ca6 2005-01-04 devnull Omittedlib["ps_ptwrite"] = 1
140 02f38ca6 2005-01-04 devnull
141 02f38ca6 2005-01-04 devnull # libmach includes a small dwarf and elf library
142 02f38ca6 2005-01-04 devnull Omittedlib["corecmdfreebsd386"] = 1
143 02f38ca6 2005-01-04 devnull Omittedlib["corecmdlinux386"] = 1
144 02f38ca6 2005-01-04 devnull Omittedlib["coreregsfreebsd386"] = 1
145 02f38ca6 2005-01-04 devnull Omittedlib["coreregslinux386"] = 1
146 02f38ca6 2005-01-04 devnull Omittedlib["coreregsmachopower"] = 1
147 02f38ca6 2005-01-04 devnull Omittedlib["crackelf"] = 1
148 02f38ca6 2005-01-04 devnull Omittedlib["crackmacho"] = 1
149 02f38ca6 2005-01-04 devnull Omittedlib["dwarfaddrtounit"] = 1
150 02f38ca6 2005-01-04 devnull Omittedlib["dwarfclose"] = 1
151 02f38ca6 2005-01-04 devnull Omittedlib["dwarfenum"] = 1
152 02f38ca6 2005-01-04 devnull Omittedlib["dwarfenumunit"] = 1
153 02f38ca6 2005-01-04 devnull Omittedlib["dwarfget1"] = 1
154 02f38ca6 2005-01-04 devnull Omittedlib["dwarfget128"] = 1
155 02f38ca6 2005-01-04 devnull Omittedlib["dwarfget128s"] = 1
156 02f38ca6 2005-01-04 devnull Omittedlib["dwarfget2"] = 1
157 02f38ca6 2005-01-04 devnull Omittedlib["dwarfget4"] = 1
158 02f38ca6 2005-01-04 devnull Omittedlib["dwarfget8"] = 1
159 02f38ca6 2005-01-04 devnull Omittedlib["dwarfgetabbrev"] = 1
160 02f38ca6 2005-01-04 devnull Omittedlib["dwarfgetaddr"] = 1
161 02f38ca6 2005-01-04 devnull Omittedlib["dwarfgetn"] = 1
162 02f38ca6 2005-01-04 devnull Omittedlib["dwarfgetnref"] = 1
163 02f38ca6 2005-01-04 devnull Omittedlib["dwarfgetstring"] = 1
164 02f38ca6 2005-01-04 devnull Omittedlib["dwarflookupfn"] = 1
165 02f38ca6 2005-01-04 devnull Omittedlib["dwarflookupname"] = 1
166 02f38ca6 2005-01-04 devnull Omittedlib["dwarflookupnameinunit"] = 1
167 02f38ca6 2005-01-04 devnull Omittedlib["dwarflookupsubname"] = 1
168 02f38ca6 2005-01-04 devnull Omittedlib["dwarflookuptag"] = 1
169 02f38ca6 2005-01-04 devnull Omittedlib["dwarfnextsym"] = 1
170 02f38ca6 2005-01-04 devnull Omittedlib["dwarfnextsymat"] = 1
171 02f38ca6 2005-01-04 devnull Omittedlib["dwarfopen"] = 1
172 02f38ca6 2005-01-04 devnull Omittedlib["dwarfpctoline"] = 1
173 02f38ca6 2005-01-04 devnull Omittedlib["dwarfseeksym"] = 1
174 02f38ca6 2005-01-04 devnull Omittedlib["dwarfskip"] = 1
175 02f38ca6 2005-01-04 devnull Omittedlib["dwarfunwind"] = 1
176 02f38ca6 2005-01-04 devnull Omittedlib["elfclose"] = 1
177 02f38ca6 2005-01-04 devnull Omittedlib["elfdl386mapdl"] = 1
178 02f38ca6 2005-01-04 devnull Omittedlib["elfinit"] = 1
179 02f38ca6 2005-01-04 devnull Omittedlib["elfmachine"] = 1
180 02f38ca6 2005-01-04 devnull Omittedlib["elfmap"] = 1
181 02f38ca6 2005-01-04 devnull Omittedlib["elfopen"] = 1
182 02f38ca6 2005-01-04 devnull Omittedlib["elfsection"] = 1
183 02f38ca6 2005-01-04 devnull Omittedlib["elfsym"] = 1
184 02f38ca6 2005-01-04 devnull Omittedlib["elfsymlookup"] = 1
185 02f38ca6 2005-01-04 devnull Omittedlib["elftype"] = 1
186 02f38ca6 2005-01-04 devnull Omittedlib["machoclose"] = 1
187 02f38ca6 2005-01-04 devnull Omittedlib["machoinit"] = 1
188 02f38ca6 2005-01-04 devnull Omittedlib["machoopen"] = 1
189 02f38ca6 2005-01-04 devnull Omittedlib["stabsym"] = 1
190 02f38ca6 2005-01-04 devnull Omittedlib["symdwarf"] = 1
191 02f38ca6 2005-01-04 devnull Omittedlib["symelf"] = 1
192 02f38ca6 2005-01-04 devnull Omittedlib["symmacho"] = 1
193 02f38ca6 2005-01-04 devnull Omittedlib["symstabs"] = 1
194 83c4506a 2005-02-11 devnull Omittedlib["elfcorelinux386"] = 1
195 83c4506a 2005-02-11 devnull Omittedlib["linux2ureg386"] = 1
196 83c4506a 2005-02-11 devnull Omittedlib["ureg2linux386"] = 1
197 83c4506a 2005-02-11 devnull Omittedlib["coreregs"] = 1 # haven't documented mach yet
198 83c4506a 2005-02-11 devnull Omittedlib["regdesc"] = 1
199 83c4506a 2005-02-11 devnull
200 83c4506a 2005-02-11 devnull Omittedlib["auth_attr"] = 1 # not happy about this
201 83c4506a 2005-02-11 devnull
202 83c4506a 2005-02-11 devnull Omittedlib["ndbnew"] = 1 # private to library
203 83c4506a 2005-02-11 devnull Omittedlib["ndbsetval"] = 1
204 02f38ca6 2005-01-04 devnull
205 02f38ca6 2005-01-04 devnull Renamelib["chanalt"] = "alt"
206 02f38ca6 2005-01-04 devnull Renamelib["channbrecv"] = "nbrecv"
207 02f38ca6 2005-01-04 devnull Renamelib["channbrecvp"] = "nbrecvp"
208 02f38ca6 2005-01-04 devnull Renamelib["channbrecvul"] = "nbrecvul"
209 02f38ca6 2005-01-04 devnull Renamelib["channbsend"] = "nbsend"
210 02f38ca6 2005-01-04 devnull Renamelib["channbsendp"] = "nbsendp"
211 02f38ca6 2005-01-04 devnull Renamelib["channbsendul"] = "nbsendul"
212 02f38ca6 2005-01-04 devnull Renamelib["chanrecv"] = "recv"
213 02f38ca6 2005-01-04 devnull Renamelib["chanrecvp"] = "recvp"
214 02f38ca6 2005-01-04 devnull Renamelib["chanrecvul"] = "recvul"
215 02f38ca6 2005-01-04 devnull Renamelib["chansend"] = "send"
216 02f38ca6 2005-01-04 devnull Renamelib["chansendp"] = "sendp"
217 02f38ca6 2005-01-04 devnull Renamelib["chansendul"] = "sendul"
218 02f38ca6 2005-01-04 devnull Renamelib["threadyield"] = "yield"
219 02f38ca6 2005-01-04 devnull
220 02f38ca6 2005-01-04 devnull Renamelib["fmtcharstod"] = "charstod"
221 02f38ca6 2005-01-04 devnull Renamelib["fmtstrtod"] = "strtod"
222 02f38ca6 2005-01-04 devnull
223 02f38ca6 2005-01-04 devnull Renamelib["regcomp9"] = "regcomp"
224 02f38ca6 2005-01-04 devnull Renamelib["regcomplit9"] = "regcomplit"
225 02f38ca6 2005-01-04 devnull Renamelib["regcompnl9"] = "regcompnl"
226 02f38ca6 2005-01-04 devnull Renamelib["regerror9"] = "regerror"
227 02f38ca6 2005-01-04 devnull Renamelib["regexec9"] = "regexec"
228 02f38ca6 2005-01-04 devnull Renamelib["regsub9"] = "regsub"
229 02f38ca6 2005-01-04 devnull Renamelib["rregexec9"] = "rregexec"
230 02f38ca6 2005-01-04 devnull Renamelib["rregsub9"] = "rregsub"
231 c8b6342d 2005-01-13 devnull
232 c8b6342d 2005-01-13 devnull lastline = "XXX";
233 c8b6342d 2005-01-13 devnull lastfile = FILENAME;
234 02f38ca6 2005-01-04 devnull }
235 02f38ca6 2005-01-04 devnull
236 02f38ca6 2005-01-04 devnull FNR==1 {
237 c8b6342d 2005-01-13 devnull if(lastline == ""){
238 c8b6342d 2005-01-13 devnull # screws up troff headers
239 c8b6342d 2005-01-13 devnull print lastfile ":$ is a blank line"
240 c8b6342d 2005-01-13 devnull }
241 c8b6342d 2005-01-13 devnull
242 c8b6342d 2005-01-13 devnull n = length(FILENAME)
243 c8b6342d 2005-01-13 devnull nam = FILENAME
244 c8b6342d 2005-01-13 devnull if(nam ~ /\.html$/)
245 c8b6342d 2005-01-13 devnull next
246 c8b6342d 2005-01-13 devnull if(nam !~ /^man\/man(.*)\/(.*)\.(.*)$/){
247 c8b6342d 2005-01-13 devnull print "nam", nam, "not of form [0-9][0-9]?/*"
248 c8b6342d 2005-01-13 devnull next
249 c8b6342d 2005-01-13 devnull }
250 c8b6342d 2005-01-13 devnull nam = substr(nam, 8)
251 c8b6342d 2005-01-13 devnull gsub("[/.]", " ", nam);
252 c8b6342d 2005-01-13 devnull n = split(nam, a)
253 c8b6342d 2005-01-13 devnull sec = a[1]
254 c8b6342d 2005-01-13 devnull name = a[2]
255 c8b6342d 2005-01-13 devnull section = a[3]
256 c8b6342d 2005-01-13 devnull if($1 != ".TH" || NF != 3)
257 c8b6342d 2005-01-13 devnull print "First line of", FILENAME, "not a proper .TH"
258 c8b6342d 2005-01-13 devnull else if(($2 != toupper(name) || substr($3, 1, length(sec)) != sec || $3 != toupper(section)) \
259 c8b6342d 2005-01-13 devnull && ($2!="INTRO" || name!="0intro") \
260 c8b6342d 2005-01-13 devnull && (name !~ /^9/ || $2!=toupper(substr(name, 2)))){
261 c8b6342d 2005-01-13 devnull print ".TH of", FILENAME, "doesn't match filename"
262 c8b6342d 2005-01-13 devnull }else
263 c8b6342d 2005-01-13 devnull Pages[tolower($2) "(" tolower($3) ")"] = 1
264 c8b6342d 2005-01-13 devnull Sh = 0
265 02f38ca6 2005-01-04 devnull }
266 02f38ca6 2005-01-04 devnull
267 c8b6342d 2005-01-13 devnull { lastline=$0; lastfile=FILENAME; }
268 c8b6342d 2005-01-13 devnull
269 02f38ca6 2005-01-04 devnull $1 == ".SH" {
270 c8b6342d 2005-01-13 devnull if(inex)
271 c8b6342d 2005-01-13 devnull print "Unterminated .EX in", FILENAME, ":", $0
272 c8b6342d 2005-01-13 devnull inex = 0;
273 c8b6342d 2005-01-13 devnull if (substr($2, 1, 1) == "\"") {
274 c8b6342d 2005-01-13 devnull if (NF == 2) {
275 c8b6342d 2005-01-13 devnull print "Unneeded quote in", FILENAME, ":", $0
276 c8b6342d 2005-01-13 devnull $2 = substr($2, 2, length($2)-2)
277 c8b6342d 2005-01-13 devnull } else if (NF == 3) {
278 c8b6342d 2005-01-13 devnull $2 = substr($2, 2) substr($3, 1, length($3)-1)
279 c8b6342d 2005-01-13 devnull NF = 2
280 02f38ca6 2005-01-04 devnull }
281 c8b6342d 2005-01-13 devnull }
282 c8b6342d 2005-01-13 devnull if(Sh == 0 && $2 != "NAME")
283 c8b6342d 2005-01-13 devnull print FILENAME, "has no .SH NAME"
284 c8b6342d 2005-01-13 devnull w = Weight[$2]
285 c8b6342d 2005-01-13 devnull if (w) {
286 c8b6342d 2005-01-13 devnull if (w < Sh)
287 c8b6342d 2005-01-13 devnull print "Heading", $2, "out of order in", FILENAME
288 c8b6342d 2005-01-13 devnull Sh += w
289 c8b6342d 2005-01-13 devnull }
290 c8b6342d 2005-01-13 devnull sh = $2
291 02f38ca6 2005-01-04 devnull }
292 02f38ca6 2005-01-04 devnull
293 02f38ca6 2005-01-04 devnull $1 == ".EX" {
294 02f38ca6 2005-01-04 devnull if(inex)
295 02f38ca6 2005-01-04 devnull print "Nested .EX in", FILENAME ":" FNR, ":", $0
296 02f38ca6 2005-01-04 devnull inex = 1
297 02f38ca6 2005-01-04 devnull }
298 02f38ca6 2005-01-04 devnull
299 02f38ca6 2005-01-04 devnull $1 == ".EE" {
300 c8b6342d 2005-01-13 devnull if(!inex)
301 c8b6342d 2005-01-13 devnull print "Bad .EE in", FILENAME ":" FNR ":", $0
302 c8b6342d 2005-01-13 devnull inex = 0;
303 02f38ca6 2005-01-04 devnull }
304 02f38ca6 2005-01-04 devnull
305 02f38ca6 2005-01-04 devnull $1 == ".TF" {
306 c8b6342d 2005-01-13 devnull smallspace = 1
307 02f38ca6 2005-01-04 devnull }
308 02f38ca6 2005-01-04 devnull
309 02f38ca6 2005-01-04 devnull $1 == ".PD" || $1 == ".SH" || $1 == ".SS" || $1 == ".TH" {
310 c8b6342d 2005-01-13 devnull smallspace = 0
311 02f38ca6 2005-01-04 devnull }
312 02f38ca6 2005-01-04 devnull
313 02f38ca6 2005-01-04 devnull $1 == ".RE" {
314 c8b6342d 2005-01-13 devnull lastre = 1
315 02f38ca6 2005-01-04 devnull }
316 02f38ca6 2005-01-04 devnull
317 02f38ca6 2005-01-04 devnull $1 == ".PP" {
318 c8b6342d 2005-01-13 devnull if(smallspace && !lastre)
319 c8b6342d 2005-01-13 devnull print "Possible missing .PD at " FILENAME ":" FNR
320 c8b6342d 2005-01-13 devnull smallspace = 0
321 02f38ca6 2005-01-04 devnull }
322 02f38ca6 2005-01-04 devnull
323 02f38ca6 2005-01-04 devnull $1 != ".RE" {
324 c8b6342d 2005-01-13 devnull lastre = 0
325 02f38ca6 2005-01-04 devnull }
326 02f38ca6 2005-01-04 devnull
327 c8b6342d 2005-01-13 devnull sh == "BUGS" && $1 == ".br" {
328 c8b6342d 2005-01-13 devnull print FILENAME ":" FNR ": .br in BUGS"
329 c8b6342d 2005-01-13 devnull }
330 c8b6342d 2005-01-13 devnull
331 c8b6342d 2005-01-13 devnull sh == "SOURCE" && $1 ~ /^\\\*9\// {
332 c8b6342d 2005-01-13 devnull s = ENVIRON["PLAN9"] substr($1, 4)
333 8bead109 2005-01-11 devnull Sources[s] = 1
334 02f38ca6 2005-01-04 devnull }
335 02f38ca6 2005-01-04 devnull
336 c8b6342d 2005-01-13 devnull sh == "SOURCE" && $2 ~ /^\\\*9\// {
337 c8b6342d 2005-01-13 devnull s = ENVIRON["PLAN9"] substr($2, 4)
338 8bead109 2005-01-11 devnull Sources[s] = 1
339 02f38ca6 2005-01-04 devnull }
340 02f38ca6 2005-01-04 devnull
341 c8b6342d 2005-01-13 devnull sh == "SOURCE" && $1 ~ /^\// {
342 c8b6342d 2005-01-13 devnull Sources[$1] = 1
343 c8b6342d 2005-01-13 devnull }
344 c8b6342d 2005-01-13 devnull
345 c8b6342d 2005-01-13 devnull sh == "SOURCE" && $2 ~ /^\// {
346 c8b6342d 2005-01-13 devnull Sources[$2] = 1
347 c8b6342d 2005-01-13 devnull }
348 c8b6342d 2005-01-13 devnull
349 02f38ca6 2005-01-04 devnull $0 ~ /^\.[A-Z].*\([1-9]\)/ {
350 02f38ca6 2005-01-04 devnull if ($1 == ".IR" && $3 ~ /\([0-9]\)/) {
351 02f38ca6 2005-01-04 devnull name = $2
352 02f38ca6 2005-01-04 devnull section = $3
353 02f38ca6 2005-01-04 devnull }else if ($1 == ".RI" && $2 == "(" && $4 ~ /\([0-9]\)/) {
354 02f38ca6 2005-01-04 devnull name = $3
355 02f38ca6 2005-01-04 devnull section = $4
356 02f38ca6 2005-01-04 devnull }else if ($1 == ".IR" && $3 ~ /9.\([0-9]\)/) {
357 02f38ca6 2005-01-04 devnull name = $2
358 02f38ca6 2005-01-04 devnull section = "9"
359 02f38ca6 2005-01-04 devnull }else if ($1 == ".RI" && $2 == "(" && $4 ~ /9.\([0-9]\)/) {
360 02f38ca6 2005-01-04 devnull name = $3
361 02f38ca6 2005-01-04 devnull section = "9"
362 02f38ca6 2005-01-04 devnull } else {
363 83c4506a 2005-02-11 devnull if ($1 == ".HR" && $3 == "\"Section")
364 83c4506a 2005-02-11 devnull next;
365 02f38ca6 2005-01-04 devnull print "Possible bad cross-reference format in", FILENAME ":" FNR
366 02f38ca6 2005-01-04 devnull print $0
367 02f38ca6 2005-01-04 devnull next
368 02f38ca6 2005-01-04 devnull }
369 02f38ca6 2005-01-04 devnull gsub(/[^0-9]/, "", section)
370 02f38ca6 2005-01-04 devnull Refs[toupper(name) "(" section ")"]++
371 02f38ca6 2005-01-04 devnull }
372 02f38ca6 2005-01-04 devnull
373 02f38ca6 2005-01-04 devnull END {
374 c8b6342d 2005-01-13 devnull if(lastline == ""){
375 c8b6342d 2005-01-13 devnull print lastfile ":$ is a blank line"
376 c8b6342d 2005-01-13 devnull }
377 c8b6342d 2005-01-13 devnull
378 02f38ca6 2005-01-04 devnull print "Checking Source References"
379 02f38ca6 2005-01-04 devnull cmd = "xargs -n 100 ls -d 2>&1 >/dev/null | sed 's/^ls: / /; s/: .*//'"
380 02f38ca6 2005-01-04 devnull for (i in Sources) {
381 02f38ca6 2005-01-04 devnull print i |cmd
382 02f38ca6 2005-01-04 devnull }
383 02f38ca6 2005-01-04 devnull close(cmd)
384 02f38ca6 2005-01-04 devnull print ""
385 02f38ca6 2005-01-04 devnull print "Checking Cross-Referenced Pages"
386 02f38ca6 2005-01-04 devnull for (i in Refs) {
387 02f38ca6 2005-01-04 devnull if (!(tolower(i) in Pages) && !(tolower(i) in Omitman)){
388 02f38ca6 2005-01-04 devnull b = tolower(i)
389 02f38ca6 2005-01-04 devnull gsub("\\(", " \\(", b)
390 02f38ca6 2005-01-04 devnull gsub("\\)", "\\)", b)
391 02f38ca6 2005-01-04 devnull split(tolower(i), a, "/")
392 02f38ca6 2005-01-04 devnull print "egrep -in '^\\.IR.*" b "' $PLAN9/man/man*/* # Need " tolower(i) |"sort"
393 02f38ca6 2005-01-04 devnull }
394 02f38ca6 2005-01-04 devnull }
395 02f38ca6 2005-01-04 devnull close("sort")
396 02f38ca6 2005-01-04 devnull print ""
397 02f38ca6 2005-01-04 devnull print "Checking commands"
398 02f38ca6 2005-01-04 devnull getindex("man/man1")
399 02f38ca6 2005-01-04 devnull getindex("man/man4")
400 02f38ca6 2005-01-04 devnull getindex("man/man7")
401 02f38ca6 2005-01-04 devnull getindex("man/man8")
402 02f38ca6 2005-01-04 devnull getbinlist("bin")
403 02f38ca6 2005-01-04 devnull for (i in List) {
404 02f38ca6 2005-01-04 devnull if (!(i in Index) && !(i in Omitted))
405 02f38ca6 2005-01-04 devnull print "Need", i, "(in " List[i] ")" |"sort"
406 02f38ca6 2005-01-04 devnull }
407 02f38ca6 2005-01-04 devnull close("sort")
408 02f38ca6 2005-01-04 devnull print ""
409 02f38ca6 2005-01-04 devnull for (i in List) {
410 02f38ca6 2005-01-04 devnull if (!(i in Index) && (i in Omitted))
411 02f38ca6 2005-01-04 devnull print "Omit", i, "(in " List[i] ")" |"sort"
412 02f38ca6 2005-01-04 devnull }
413 02f38ca6 2005-01-04 devnull close("sort")
414 02f38ca6 2005-01-04 devnull clearindex()
415 02f38ca6 2005-01-04 devnull clearlist()
416 02f38ca6 2005-01-04 devnull print ""
417 02f38ca6 2005-01-04 devnull print "Checking libraries"
418 02f38ca6 2005-01-04 devnull getindex("man/man3")
419 02f38ca6 2005-01-04 devnull getnmlist("lib/lib9.a")
420 02f38ca6 2005-01-04 devnull getnmlist("lib/lib9p.a")
421 02f38ca6 2005-01-04 devnull getnmlist("lib/lib9pclient.a")
422 02f38ca6 2005-01-04 devnull getnmlist("lib/libString.a")
423 83c4506a 2005-02-11 devnull getnmlist("lib/libauth.a")
424 83c4506a 2005-02-11 devnull getnmlist("lib/libauthsrv.a")
425 02f38ca6 2005-01-04 devnull getnmlist("lib/libbin.a")
426 02f38ca6 2005-01-04 devnull getnmlist("lib/libbio.a")
427 02f38ca6 2005-01-04 devnull getnmlist("lib/libcomplete.a")
428 02f38ca6 2005-01-04 devnull # getnmlist("lib/libcontrol.a")
429 02f38ca6 2005-01-04 devnull getnmlist("lib/libdisk.a")
430 02f38ca6 2005-01-04 devnull getnmlist("lib/libdraw.a")
431 02f38ca6 2005-01-04 devnull getnmlist("lib/libflate.a")
432 02f38ca6 2005-01-04 devnull getnmlist("lib/libframe.a")
433 02f38ca6 2005-01-04 devnull getnmlist("lib/libgeometry.a")
434 02f38ca6 2005-01-04 devnull getnmlist("lib/libhtml.a")
435 02f38ca6 2005-01-04 devnull # getnmlist("lib/libhttpd.a")
436 02f38ca6 2005-01-04 devnull getnmlist("lib/libip.a")
437 02f38ca6 2005-01-04 devnull getnmlist("lib/libmach.a")
438 02f38ca6 2005-01-04 devnull # getnmlist("lib/libmemdraw.a")
439 02f38ca6 2005-01-04 devnull # getnmlist("lib/libmemlayer.a")
440 02f38ca6 2005-01-04 devnull getnmlist("lib/libmp.a")
441 02f38ca6 2005-01-04 devnull getnmlist("lib/libmux.a")
442 83c4506a 2005-02-11 devnull getnmlist("lib/libndb.a")
443 02f38ca6 2005-01-04 devnull getnmlist("lib/libplumb.a")
444 02f38ca6 2005-01-04 devnull getnmlist("lib/libregexp9.a")
445 02f38ca6 2005-01-04 devnull getnmlist("lib/libsec.a")
446 02f38ca6 2005-01-04 devnull getnmlist("lib/libthread.a")
447 02f38ca6 2005-01-04 devnull # getnmlist("lib/libventi.a")
448 02f38ca6 2005-01-04 devnull for (i in List) {
449 02f38ca6 2005-01-04 devnull if (!(i in Index) && !(i in Omittedlib))
450 02f38ca6 2005-01-04 devnull print "Need", List[i], i |"sort"
451 02f38ca6 2005-01-04 devnull # print "Need", i, "(in " List[i] ")" |"sort"
452 02f38ca6 2005-01-04 devnull }
453 02f38ca6 2005-01-04 devnull close("sort")
454 02f38ca6 2005-01-04 devnull print ""
455 02f38ca6 2005-01-04 devnull for (i in List) {
456 02f38ca6 2005-01-04 devnull if (!(i in Index) && (i in Omittedlib))
457 02f38ca6 2005-01-04 devnull print "Omit", List[i], i |"sort"
458 02f38ca6 2005-01-04 devnull # print "Omit", i, "(in " List[i] ")" |"sort"
459 02f38ca6 2005-01-04 devnull }
460 02f38ca6 2005-01-04 devnull close("sort")
461 02f38ca6 2005-01-04 devnull }
462 02f38ca6 2005-01-04 devnull
463 02f38ca6 2005-01-04 devnull func getindex(dir, fname)
464 02f38ca6 2005-01-04 devnull {
465 02f38ca6 2005-01-04 devnull fname = dir "/INDEX"
466 02f38ca6 2005-01-04 devnull while ((getline < fname) > 0)
467 02f38ca6 2005-01-04 devnull Index[$1] = dir
468 02f38ca6 2005-01-04 devnull close(fname)
469 02f38ca6 2005-01-04 devnull }
470 02f38ca6 2005-01-04 devnull
471 02f38ca6 2005-01-04 devnull func getbinlist(dir, cmd, subdirs, nsd)
472 02f38ca6 2005-01-04 devnull {
473 02f38ca6 2005-01-04 devnull cmd = "ls -p -l " dir
474 02f38ca6 2005-01-04 devnull nsd = 0
475 02f38ca6 2005-01-04 devnull while (cmd | getline) {
476 02f38ca6 2005-01-04 devnull if ($1 ~ /^d/) {
477 02f38ca6 2005-01-04 devnull if (!($10 in Skipdirs))
478 02f38ca6 2005-01-04 devnull subdirs[++nsd] = $10
479 02f38ca6 2005-01-04 devnull } else if ($10 !~ "^_")
480 02f38ca6 2005-01-04 devnull List[$10] = dir
481 02f38ca6 2005-01-04 devnull }
482 02f38ca6 2005-01-04 devnull for ( ; nsd > 0 ; nsd--)
483 02f38ca6 2005-01-04 devnull getbinlist(dir "/" subdirs[nsd])
484 02f38ca6 2005-01-04 devnull close(cmd)
485 02f38ca6 2005-01-04 devnull }
486 02f38ca6 2005-01-04 devnull
487 02f38ca6 2005-01-04 devnull func getnmlist(lib, cmd)
488 02f38ca6 2005-01-04 devnull {
489 02f38ca6 2005-01-04 devnull cmd = "nm -g " lib
490 02f38ca6 2005-01-04 devnull while (cmd | getline) {
491 02f38ca6 2005-01-04 devnull if (($2 == "T" || $2 == "L") && $3 !~ "^_"){
492 02f38ca6 2005-01-04 devnull sym = $3
493 02f38ca6 2005-01-04 devnull sub("^p9", "", sym)
494 02f38ca6 2005-01-04 devnull if(sym in Renamelib)
495 02f38ca6 2005-01-04 devnull List[Renamelib[sym]] = lib " as " sym
496 02f38ca6 2005-01-04 devnull else
497 02f38ca6 2005-01-04 devnull List[sym] = lib
498 02f38ca6 2005-01-04 devnull }
499 02f38ca6 2005-01-04 devnull }
500 02f38ca6 2005-01-04 devnull close(cmd)
501 02f38ca6 2005-01-04 devnull }
502 02f38ca6 2005-01-04 devnull
503 02f38ca6 2005-01-04 devnull func clearindex( i)
504 02f38ca6 2005-01-04 devnull {
505 02f38ca6 2005-01-04 devnull for (i in Index)
506 02f38ca6 2005-01-04 devnull delete Index[i]
507 02f38ca6 2005-01-04 devnull }
508 02f38ca6 2005-01-04 devnull
509 02f38ca6 2005-01-04 devnull func clearlist( i)
510 02f38ca6 2005-01-04 devnull {
511 02f38ca6 2005-01-04 devnull for (i in List)
512 02f38ca6 2005-01-04 devnull delete List[i]
513 02f38ca6 2005-01-04 devnull }