NAME [edit section]

= NAME =gen_report

SYNOPSIS [edit section]

= SYNOPSIS =gen_report

DESCRIPTION [edit section]

= DESCRIPTION =If a batch testplan is being executed (BATCH_TESTPLAN and LOGRUN_FILE are set),then gen_report runs a sequence of commands to generate a PDF reportfor the batch job.

This function is only called by a special Jenkins job, called Report.make_pdf.

This program does the following steps: * creates an XML file, using [[gentexml.py]] * converts the XML file to TEX format, using '''texml''' * converts the TEX file to PDF format, using pdflatex

EXAMPLES [edit section]

= EXAMPLES =Here are some sample invocations:{{{#!YellowBoxgen_report}}}

ENVIRONMENT and ARGUMENTS [edit section]

= ENVIRONMENT and ARGUMENTS =

RETURN [edit section]

= RETURN =Produces a PDF file from batch job results on success.

SOURCE [edit section]

= SOURCE =Located in ''scripts/reports.sh''

SEE ALSO [edit section]

= SEE ALSO = * [[gentexml.py]], [[Report Generator]], [[loggen.py]]