Debian Codegraph @

upstream/opensuse-tumbleweed/man3/TAP::Harness::Env.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "TAP::Harness::Env 3pm"
61 .TH TAP::Harness::Env 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 TAP::Harness::Env \- Parsing harness related environmental variables where appropriate
68 .SH VERSION
69 .IX Header "VERSION"
70 Version 3.50
71 .SH SYNOPSIS
72 .IX Header "SYNOPSIS"
73 .Vb 1
74 \& my $harness = TAP::Harness::Env\->create(\e%extra_args)
75 .Ve
76 .SH DESCRIPTION
77 .IX Header "DESCRIPTION"
78 This module implements the environmental variables that Test::Harness uses with TAP::Harness, and instantiates the appropriate class with the appropriate arguments.
79 .SH METHODS
80 .IX Header "METHODS"
81 .IP \(bu 4
82 create( \e%args )
83 .Sp
84 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.
85 .SH "ENVIRONMENTAL VARIABLES"
86 .IX Header "ENVIRONMENTAL VARIABLES"
87 .ie n .IP """HARNESS_PERL_SWITCHES""" 4
88 .el .IP \f(CWHARNESS_PERL_SWITCHES\fR 4
89 .IX Item "HARNESS_PERL_SWITCHES"
90 Setting this adds perl command line switches to each test file run.
91 .Sp
92 For example, \f(CW\*(C`HARNESS_PERL_SWITCHES=\-T\*(C'\fR will turn on taint mode.
93 \&\f(CW\*(C`HARNESS_PERL_SWITCHES=\-MDevel::Cover\*(C'\fR will run \f(CW\*(C`Devel::Cover\*(C'\fR for
94 each test.
95 .ie n .IP """HARNESS_VERBOSE""" 4
96 .el .IP \f(CWHARNESS_VERBOSE\fR 4
97 .IX Item "HARNESS_VERBOSE"
98 If true, \f(CW\*(C`TAP::Harness\*(C'\fR will output the verbose results of running
99 its tests.
100 .ie n .IP """HARNESS_SUBCLASS""" 4
101 .el .IP \f(CWHARNESS_SUBCLASS\fR 4
102 .IX Item "HARNESS_SUBCLASS"
103 Specifies a TAP::Harness subclass to be used in place of TAP::Harness.
104 .ie n .IP """HARNESS_OPTIONS""" 4
105 .el .IP \f(CWHARNESS_OPTIONS\fR 4
106 .IX Item "HARNESS_OPTIONS"
107 Provide additional options to the harness. Currently supported options are:
108 .RS 4
109 .ie n .IP """j<n>""" 4
110 .el .IP \f(CWj<n>\fR 4
111 .IX Item "j<n>"
112 Run <n> (default 9) parallel jobs.
113 .ie n .IP """c""" 4
114 .el .IP \f(CWc\fR 4
115 .IX Item "c"
116 Try to color output. See "new" in TAP::Formatter::Base.
117 .ie n .IP """a<file.tgz>""" 4
118 .el .IP \f(CWa<file.tgz>\fR 4
119 .IX Item "a<file.tgz>"
120 Will use TAP::Harness::Archive as the harness class, and save the TAP to
121 \&\f(CW\*(C`file.tgz\*(C'\fR
122 .ie n .IP """fPackage\-With\-Dashes""" 4
123 .el .IP \f(CWfPackage\-With\-Dashes\fR 4
124 .IX Item "fPackage-With-Dashes"
125 Set the formatter_class of the harness being run. Since the \f(CW\*(C`HARNESS_OPTIONS\*(C'\fR
126 is separated by \f(CW\*(C`:\*(C'\fR, we use \f(CW\*(C`\-\*(C'\fR instead.
127 .RE
128 .RS 4
129 .Sp
130 Multiple options may be separated by colons:
131 .Sp
132 .Vb 1
133 \& HARNESS_OPTIONS=j9:c make test
134 .Ve
135 .RE
136 .ie n .IP """HARNESS_TIMER""" 4
137 .el .IP \f(CWHARNESS_TIMER\fR 4
138 .IX Item "HARNESS_TIMER"
139 Setting this to true will make the harness display the number of
140 milliseconds each test took. You can also use \fIprove\fR\*(Aqs \f(CW\*(C`\-\-timer\*(C'\fR
141 switch.
142 .ie n .IP """HARNESS_COLOR""" 4
143 .el .IP \f(CWHARNESS_COLOR\fR 4
144 .IX Item "HARNESS_COLOR"
145 Attempt to produce color output.
146 .ie n .IP """HARNESS_IGNORE_EXIT""" 4
147 .el .IP \f(CWHARNESS_IGNORE_EXIT\fR 4
148 .IX Item "HARNESS_IGNORE_EXIT"
149 If set to a true value instruct \f(CW\*(C`TAP::Parser\*(C'\fR to ignore exit and wait
150 status from test scripts.