Mercurial > vim

view runtime/doc/maketags.awk @ 34129:aa539262b6a7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
line wrap: on
line source

BEGIN   { FS="	"; }

NR == 1 { nf=split(FILENAME,f,".")
	print "<HTML>";
	print "<HEAD><TITLE>" f[1] "</TITLE></HEAD>";
	print "<BODY BGCOLOR=\"#ffffff\">";
	print "<H1>Vim Documentation: " f[1] "</H1>";
	print "<A NAME=\"top\"></A>";
	print "<HR>";
	print "<PRE>";
}

{
	#
	# protect special chars
	#
	gsub(/&/,"\\&amp;");
	gsub(/>/,"\\&gt;");
	gsub(/</,"\\&lt;");
	gsub(/"/,"\\&quot;");
	gsub(/%/,"\\&#37;");

	nf=split($0,tag,"	");
	if (counttag[tag[1]] > 0)
	{
		print "==============" > "errors.log"
		print "Duplicate Tag " tag[1] > "errors.log"
		print "==============" > "errors.log"
	}
	counttag[tag[1]]++
	tagkey[t]=tag[1];tagref[t]=tag[2];tagnum[t]=NR;
	print $1 "	" $2 "	line " NR >"tags.ref"
	n=split($2,w,".");
	printf ("|<A HREF=\"%s.html#%s\">%s</A>|	%s\n",w[1],$1,$1,$2);
}

END     {
	topback();
	print "</PRE>\n</BODY>\n\n\n</HTML>";
	}

#
# as main we keep index.txt (by default)
# other candidate, help.txt
#
function topback () {
	printf("<A HREF=\"#top\">top</A> - ");
	printf("<A HREF=\"help.html\">back to help</A>\n");
}