.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Test::Lintian::Templates 3"
.TH Test::Lintian::Templates 3 "2021-02-01" "Lintian v2.104.0~bpo10+1" "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::Templates \-\- Helper routines dealing with templates
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
use Test::Lintian::Templates qw(fill_template);
.PP
my \f(CW$data\fR = { 'placeholder' => 'value' };
my \f(CW$file\fR = '/path/to/generated/file';
.PP
fill_template(\*(L"$file.in\*(R", \f(CW$file\fR, \f(CW$data\fR);
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Routines for dealing with templates in Lintian test specifications.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.IP "copy_skeleton_template_sets(\s-1INSTRUCTIONS, RUN_PATH, SUITE, TEST_SET\s0)" 4
.IX Item "copy_skeleton_template_sets(INSTRUCTIONS, RUN_PATH, SUITE, TEST_SET)"
Copies template sets belonging to \s-1SUITE\s0 into the test working directory
\&\s-1RUN_PATH\s0 according to \s-1INSTRUCTIONS.\s0 The \s-1INSTRUCTIONS\s0 are the target
directory relative to \s-1RUN_PATH\s0 followed by the name of the template set
in parentheses. Multiple such instructions must be separated by commas.
.IP "remove_surplus_templates(\s-1SRC_DIR, TARGET_DIR\s0)" 4
.IX Item "remove_surplus_templates(SRC_DIR, TARGET_DIR)"
Removes from \s-1TARGET_DIR\s0 any templates that have corresponding originals
in \s-1SRC_DIR.\s0
.IP "fill_skeleton_templates(\s-1INSTRUCTIONS, HASH, EPOCH, RUN_PATH, TEST_SET\s0)" 4
.IX Item "fill_skeleton_templates(INSTRUCTIONS, HASH, EPOCH, RUN_PATH, TEST_SET)"
Fills the templates specified in \s-1INSTRUCTIONS\s0 using the data in \s-1HASH.\s0 Only
fills templates when the generated files are not present or are older than
either the file modification time of the template or the age of the data
as evidenced by \s-1EPOCH.\s0 The \s-1INSTRUCTIONS\s0 are the target directory relative
to \s-1RUN_PATH\s0 followed by the name of the whitelist in parentheses. Multiple
instructions must be separated by commas.
.IP "fill_whitelisted_templates(\s-1DIR, WHITE_LIST, HASH, HASH_EPOCH\s0)" 4
.IX Item "fill_whitelisted_templates(DIR, WHITE_LIST, HASH, HASH_EPOCH)"
Generates all files in array \s-1WHITE_LIST\s0 relative to \s-1DIR\s0 from their templates,
which are assumed to have the same file name but with extension '.in', using
data provided in \s-1HASH.\s0 The optional argument \s-1HASH_EPOCH\s0 can be used to
preserve files when no generation is necessary.
.IP "fill_all_templates(\s-1HASH, DIR\s0)" 4
.IX Item "fill_all_templates(HASH, DIR)"
Fills all templates in \s-1DIR\s0 with data from \s-1HASH.\s0
.IP "fill_template(\s-1TEMPLATE, GENERATED, HASH, HASH_EPOCH, DELIMITERS\s0)" 4
.IX Item "fill_template(TEMPLATE, GENERATED, HASH, HASH_EPOCH, DELIMITERS)"
Fills template \s-1TEMPLATE\s0 with data from \s-1HASH\s0 and places the result in
file \s-1GENERATED.\s0 When given \s-1HASH_EPOCH,\s0 will evaluate beforehand if a
substitution is necessary based on file modification times. The optional
parameter \s-1DELIMITERS\s0 can be used to change the standard delimiters.