Debian Codegraph @

upstream/debian-unstable/man3/TAP::Harness::Env.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "TAP::Harness::Env 3perl"
58 .TH TAP::Harness::Env 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 TAP::Harness::Env \- Parsing harness related environmental variables where appropriate
65 .SH VERSION
66 .IX Header "VERSION"
67 Version 3.48
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& my $harness = TAP::Harness::Env\->create(\e%extra_args)
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 This module implements the environmental variables that Test::Harness uses with TAP::Harness, and instantiates the appropriate class with the appropriate arguments.
76 .SH METHODS
77 .IX Header "METHODS"
78 .IP \(bu 4
79 create( \e%args )
80 .Sp
81 This function reads the environment and generates an appropriate argument hash from it. If given any arguments in \f(CW%extra_args\fR, these will override the environmental defaults. In accepts \f(CW\*(C`harness_class\*(C'\fR (which defaults to \f(CW\*(C`TAP::Harness\*(C'\fR), and any argument the harness class accepts.
82 .SH "ENVIRONMENTAL VARIABLES"
83 .IX Header "ENVIRONMENTAL VARIABLES"
84 .ie n .IP """HARNESS_PERL_SWITCHES""" 4
85 .el .IP \f(CWHARNESS_PERL_SWITCHES\fR 4
86 .IX Item "HARNESS_PERL_SWITCHES"
87 Setting this adds perl command line switches to each test file run.
88 .Sp
89 For example, \f(CW\*(C`HARNESS_PERL_SWITCHES=\-T\*(C'\fR will turn on taint mode.
90 \&\f(CW\*(C`HARNESS_PERL_SWITCHES=\-MDevel::Cover\*(C'\fR will run \f(CW\*(C`Devel::Cover\*(C'\fR for
91 each test.
92 .ie n .IP """HARNESS_VERBOSE""" 4
93 .el .IP \f(CWHARNESS_VERBOSE\fR 4
94 .IX Item "HARNESS_VERBOSE"
95 If true, \f(CW\*(C`TAP::Harness\*(C'\fR will output the verbose results of running
96 its tests.
97 .ie n .IP """HARNESS_SUBCLASS""" 4
98 .el .IP \f(CWHARNESS_SUBCLASS\fR 4
99 .IX Item "HARNESS_SUBCLASS"
100 Specifies a TAP::Harness subclass to be used in place of TAP::Harness.
101 .ie n .IP """HARNESS_OPTIONS""" 4
102 .el .IP \f(CWHARNESS_OPTIONS\fR 4
103 .IX Item "HARNESS_OPTIONS"
104 Provide additional options to the harness. Currently supported options are:
105 .RS 4
106 .ie n .IP """j<n>""" 4
107 .el .IP \f(CWj<n>\fR 4
108 .IX Item "j<n>"
109 Run <n> (default 9) parallel jobs.
110 .ie n .IP """c""" 4
111 .el .IP \f(CWc\fR 4
112 .IX Item "c"
113 Try to color output. See "new" in TAP::Formatter::Base.
114 .ie n .IP """a<file.tgz>""" 4
115 .el .IP \f(CWa<file.tgz>\fR 4
116 .IX Item "a<file.tgz>"
117 Will use TAP::Harness::Archive as the harness class, and save the TAP to
118 \&\f(CW\*(C`file.tgz\*(C'\fR
119 .ie n .IP """fPackage\-With\-Dashes""" 4
120 .el .IP \f(CWfPackage\-With\-Dashes\fR 4
121 .IX Item "fPackage-With-Dashes"
122 Set the formatter_class of the harness being run. Since the \f(CW\*(C`HARNESS_OPTIONS\*(C'\fR
123 is separated by \f(CW\*(C`:\*(C'\fR, we use \f(CW\*(C`\-\*(C'\fR instead.
124 .RE
125 .RS 4
126 .Sp
127 Multiple options may be separated by colons:
128 .Sp
129 .Vb 1
130 \& HARNESS_OPTIONS=j9:c make test
131 .Ve
132 .RE
133 .ie n .IP """HARNESS_TIMER""" 4
134 .el .IP \f(CWHARNESS_TIMER\fR 4
135 .IX Item "HARNESS_TIMER"
136 Setting this to true will make the harness display the number of
137 milliseconds each test took. You can also use \fIprove\fR's \f(CW\*(C`\-\-timer\*(C'\fR
138 switch.
139 .ie n .IP """HARNESS_COLOR""" 4
140 .el .IP \f(CWHARNESS_COLOR\fR 4
141 .IX Item "HARNESS_COLOR"
142 Attempt to produce color output.
143 .ie n .IP """HARNESS_IGNORE_EXIT""" 4
144 .el .IP \f(CWHARNESS_IGNORE_EXIT\fR 4
145 .IX Item "HARNESS_IGNORE_EXIT"
146 If set to a true value instruct \f(CW\*(C`TAP::Parser\*(C'\fR to ignore exit and wait
147 status from test scripts.