Mercurial > vim
annotate runtime/doc/maketags.awk @ 34129:aa539262b6a7
CI: Check help tags for errors (duplicates, missing, etc) (#13865)
Commit: https://github.com/vim/vim/commit/8102a4c463c21f3bba4f27f0dbc402b9850de915
Author: Christian Brabandt <cb@256bit.org>
Date: Sun Jan 14 18:24:05 2024 +0000
CI: Check help tags for errors (duplicates, missing, etc) (https://github.com/vim/vim/issues/13865)
- Run the doc make html awk script, which also checks, that all
referenced help tags exists.
- Run the doc maketags awk script, which checks for duplicates
- in case of any error in the previous two steps, exit the CI with
an error and show the errors.log file, that is generated by the
previous 2 steps
Signed-off-by: Christian Brabandt <cb@256bit.org>
author | Christian Brabandt <cb@256bit.org> |
---|---|
date | Sun, 14 Jan 2024 19:30:02 +0100 |
parents | 3fc0f57ecb91 |
children |
rev | line source |
---|---|
7 | 1 BEGIN { FS=" "; } |
2 | |
3 NR == 1 { nf=split(FILENAME,f,".") | |
4 print "<HTML>"; | |
5 print "<HEAD><TITLE>" f[1] "</TITLE></HEAD>"; | |
6 print "<BODY BGCOLOR=\"#ffffff\">"; | |
7 print "<H1>Vim Documentation: " f[1] "</H1>"; | |
8 print "<A NAME=\"top\"></A>"; | |
9 print "<HR>"; | |
10 print "<PRE>"; | |
11 } | |
12 | |
13 { | |
14 # | |
15 # protect special chars | |
16 # | |
17 gsub(/&/,"\\&"); | |
18 gsub(/>/,"\\>"); | |
19 gsub(/</,"\\<"); | |
20 gsub(/"/,"\\""); | |
21 gsub(/%/,"\\%"); | |
22 | |
23 nf=split($0,tag," "); | |
34129
aa539262b6a7
CI: Check help tags for errors (duplicates, missing, etc) (#13865)
Christian Brabandt <cb@256bit.org>
parents:
7
diff
changeset
|
24 if (counttag[tag[1]] > 0) |
aa539262b6a7
CI: Check help tags for errors (duplicates, missing, etc) (#13865)
Christian Brabandt <cb@256bit.org>
parents:
7
diff
changeset
|
25 { |
aa539262b6a7
CI: Check help tags for errors (duplicates, missing, etc) (#13865)
Christian Brabandt <cb@256bit.org>
parents:
7
diff
changeset
|
26 print "==============" > "errors.log" |
aa539262b6a7
CI: Check help tags for errors (duplicates, missing, etc) (#13865)
Christian Brabandt <cb@256bit.org>
parents:
7
diff
changeset
|
27 print "Duplicate Tag " tag[1] > "errors.log" |
aa539262b6a7
CI: Check help tags for errors (duplicates, missing, etc) (#13865)
Christian Brabandt <cb@256bit.org>
parents:
7
diff
changeset
|
28 print "==============" > "errors.log" |
aa539262b6a7
CI: Check help tags for errors (duplicates, missing, etc) (#13865)
Christian Brabandt <cb@256bit.org>
parents:
7
diff
changeset
|
29 } |
aa539262b6a7
CI: Check help tags for errors (duplicates, missing, etc) (#13865)
Christian Brabandt <cb@256bit.org>
parents:
7
diff
changeset
|
30 counttag[tag[1]]++ |
7 | 31 tagkey[t]=tag[1];tagref[t]=tag[2];tagnum[t]=NR; |
32 print $1 " " $2 " line " NR >"tags.ref" | |
33 n=split($2,w,"."); | |
34 printf ("|<A HREF=\"%s.html#%s\">%s</A>| %s\n",w[1],$1,$1,$2); | |
35 } | |
36 | |
37 END { | |
38 topback(); | |
39 print "</PRE>\n</BODY>\n\n\n</HTML>"; | |
40 } | |
41 | |
42 # | |
43 # as main we keep index.txt (by default) | |
44 # other candidate, help.txt | |
45 # | |
46 function topback () { | |
47 printf("<A HREF=\"#top\">top</A> - "); | |
48 printf("<A HREF=\"help.html\">back to help</A>\n"); | |
49 } |