op public repos

Blob

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