op public repos

Blob

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