Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::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 "Test2::Env 3pm"
61 .TH Test2::Env 3pm 2025-06-24 "perl v5.42.0" "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 Test2::Env \- Documentation for environment variables used or set by Test2.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This is a list of environment variables that are either set by, or read by Test2.
71 .SH AUTHOR_TESTING
72 .IX Header "AUTHOR_TESTING"
73 This env var is read by Test2. When set Test2 will run tests that are normally
74 skipped unless a module author is doing extra author\-specific testing.
75 .SH AUTOMATED_TESTING
76 .IX Header "AUTOMATED_TESTING"
77 This env var is read by Test2. When set this indicates the tests are run by an
78 automated system and no human interaction is possible.
79 .PP
80 See Test2::Require::AuthorTesting.
81 .SH EXTENDED_TESTING
82 .IX Header "EXTENDED_TESTING"
83 This env var is read by Test2. When set it indicates some extended testing that
84 should normally be skipped will be run.
85 .PP
86 See Test2::Require::ExtendedTesting.
87 .SH HARNESS_ACTIVE
88 .IX Header "HARNESS_ACTIVE"
89 This env var is read by Test2. It is usually set by \f(CW\*(C`prove\*(C'\fR (Test::Harness)
90 or \f(CW\*(C`yath\*(C'\fR (App::Yath).
91 .SH NONINTERACTIVE_TESTING
92 .IX Header "NONINTERACTIVE_TESTING"
93 This env var is read by Test2. When set this indicates the testing will not be
94 interactive.
95 .PP
96 See Test2::Require::NonInteractiveTesting.
97 .SH RELEASE_TESTING
98 .IX Header "RELEASE_TESTING"
99 This env var is read by Test2. When set this indicates that release testing is
100 being done, which may run more tests than normal.
101 .PP
102 See Test2::Require::ReleaseTesting.
103 .SH T2_FORMATTER
104 .IX Header "T2_FORMATTER"
105 This can be used to set the formatter that Test2 will use. If set to a string
106 without a \*(Aq+\*(Aq prefix, then \*(AqTest2::Formatter::\*(Aq will be added to the start of
107 the module name. If \*(Aq+\*(Aq is present it will be stripped and no further
108 modification will be made to the module name.
109 .SH T2_IN_PRELOAD
110 .IX Header "T2_IN_PRELOAD"
111 Test2 sets this when preload mode is active. This is mainly used by
112 App::Yath and similar tools that preload Test2, then fork to run tests.
113 .SH TABLE_TERM_SIZE
114 .IX Header "TABLE_TERM_SIZE"
115 This is used to set a terminal width for things like diagnostic message tables.
116 .SH TEST2_ACTIVE
117 .IX Header "TEST2_ACTIVE"
118 Test2 sets this variable when tests are running.
119 .SH TEST2_ENABLE_PLUGINS
120 .IX Header "TEST2_ENABLE_PLUGINS"
121 This can be used to force plugins to be loaded whent he Test2 API is loaded. It
122 takes a list of one or more plugin names seperated by comma. If the module name
123 does not have a \*(Aq+\*(Aq in front of it then the \f(CW\*(C`Test2::Plugin::\*(C'\fR namespace is
124 assumed and added. If a \*(Aq+\*(Aq is present at the start of a module name it will be
125 stripped and no further modification will be made.
126 .PP
127 Examples:
128 .PP
129 .Vb 2
130 \& TEST2_ENABLE_PLUGINS=BailOnFail
131 \& Test2_ENABLE_PLUGINS=SRand,+My::Plugin::Name
132 .Ve
133 .SH TEST_ACTIVE
134 .IX Header "TEST_ACTIVE"
135 Set by Test2 when tests are running.
136 .SH TS_MAX_DELTA
137 .IX Header "TS_MAX_DELTA"
138 Used to determine how many max lines of output will be provided when \fBis()\fR finds
139 a deep data strucgture mismatch.
140 .SH SOURCE
141 .IX Header "SOURCE"
142 The source code repository for Test2\-Suite can be found at
143 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
144 .SH MAINTAINERS
145 .IX Header "MAINTAINERS"
146 .IP "Chad Granum <[email protected]>" 4
147 .IX Item "Chad Granum <[email protected]>"
148 .SH AUTHORS
149 .IX Header "AUTHORS"
150 .IP "Chad Granum <[email protected]>" 4
151 .IX Item "Chad Granum <[email protected]>"
152 .SH COPYRIGHT
153 .IX Header "COPYRIGHT"
154 Copyright Chad Granum <[email protected]>.
155 .PP
156 This program is free software; you can redistribute it and/or
157 modify it under the same terms as Perl itself.
158 .PP
159 See \fIhttp://dev.perl.org/licenses/\fR