.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Test::Lintian::Hooks 3"
.TH Test::Lintian::Hooks 3 2024-02-05 "Lintian v2.117.0" "Debian Package Checker"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Test::Lintian::Hooks \-\- hook routines for the test runners
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  use Test::Lintian::Hooks qw(sed_hook);
\&  sed_hook(\*(Aqscript.sed\*(Aq, \*(Aqinput.file\*(Aq);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Various hook routines for the test runners.
.SH FUNCTIONS
.IX Header "FUNCTIONS"
.IP "sed_hook(SCRIPT, SUBJECT, OUTPUT)" 4
.IX Item "sed_hook(SCRIPT, SUBJECT, OUTPUT)"
Runs the parser sed on file SUBJECT using the instructions in SCRIPT
and places the result in the file OUTPUT.
.IP "sort_lines(UNSORTED, SORTED)" 4
.IX Item "sort_lines(UNSORTED, SORTED)"
Sorts the file UNSORTED line by line and places the result into the
file SORTED.
.IP "calibrate(SCRIPT, ACTUAL, EXPECTED, CALIBRATED)" 4
.IX Item "calibrate(SCRIPT, ACTUAL, EXPECTED, CALIBRATED)"
Executes calibration script SCRIPT with the three arguments EXPECTED,
ACTUAL and CALIBRATED, all of which are file paths. Please note that
the order of arguments in this function corresponds to the
bookkeeping logic of ACTUAL vs EXPECTED. The order for the script is
different.
.IP find_missing_prerequisites(TEST_CASE) 4
.IX Item "find_missing_prerequisites(TEST_CASE)"
Returns a string with missing dependencies, if applicable, that would
be necessary to run the test described by hash DESC.