Skip to content

set an exit code in make_doc #5835

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fingolfin merged 4 commits into from
Nov 27, 2024
Merged

set an exit code in make_doc #5835

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9ceb10d
set an exit code in `make_doc`
ThomasBreuer Nov 8, 2024
51a6ee2
show the errors if there are some
ThomasBreuer Nov 9, 2024
00294a0
call GAP with the `-r` option in `make_doc`
ThomasBreuer Nov 10, 2024
5a34c53
collect output messages separately in both runs
ThomasBreuer Nov 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 28 additions & 5 deletions doc/make_doc.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ set -e
set -o pipefail

GAP=@abs_top_builddir@/gap
GAPARGS="-b -m 1g -x 80 -q --quitonbreak"
GAPARGS="-b -m 1g -x 80 -q --quitonbreak -r"
if [ "$1" == "nopdf" ]; then
NOPDF=", \"nopdf\""
else
Expand All @@ -20,6 +20,13 @@ books:=["ref", "tut", "hpc", "dev"];;
latexOpts := rec(Maintitlesize := "\\\\fontsize{36}{38}\\\\selectfont");;
UpdateXMLForUserPreferences();
for run in [1,2] do
# collect output messages separately in both runs
outputstring:= "";;
outputstream:= OutputTextString(outputstring, true);;
SetPrintFormattingStatus(outputstream, false);
SetInfoOutput(InfoGAPDoc, outputstream);
SetInfoOutput(InfoWarning, outputstream);

for book in books do
path := Concatenation(base, "/doc/", book);
dir := Directory(path);
Expand All @@ -29,10 +36,10 @@ for run in [1,2] do
continue;
fi;

Print("----------------------------\n");
Print("Building GAP manual '",book,"' at ",path,"\n");
Print("Run ",run," of 2\n");
Print("----------------------------\n");
AppendTo(outputstream, "----------------------------\n");
AppendTo(outputstream, "Building GAP manual '",book,"' at ",path,"\n");
AppendTo(outputstream, "Run ",run," of 2\n");
AppendTo(outputstream, "----------------------------\n");

# for the reference manual, extra list of source files to scan
if book = "ref" then
Expand Down Expand Up @@ -65,5 +72,21 @@ for run in [1,2] do
SetGapDocLaTeXOptions("color", latexOpts);
MakeGAPDocDoc( path, "main.xml", files, book, "../..", "MathJax" $NOPDF);;
od;

CloseStream(outputstream);
UnbindInfoOutput(InfoGAPDoc);
UnbindInfoOutput(InfoWarning);
Print(outputstring);
od;

# evaluate the outputs for the second run
outputstring:= ReplacedString(outputstring, "\c", "");;
errors:= Filtered(SplitString(outputstring, "\n"),
x -> StartsWith(x, "#W ") and x <> "#W There are overfull boxes:");;
if Length(errors) = 0 then
QuitGap(true);
else
Print(errors, "\n");
QuitGap(false);
fi;
EOF