Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::Require::Threads.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::Require::Threads 3pm"
61 .TH Test2::Require::Threads 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::Require::Threads \- Skip a test file unless the system supports threading
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 It is fairly common to write tests that need to use threads. Not all systems
71 support threads. This library does the hard work of checking if threading is
72 supported on the current system. If threading is not supported then this will
73 skip all tests and exit true.
74 .SH SYNOPSIS
75 .IX Header "SYNOPSIS"
76 .Vb 1
77 \& use Test2::Require::Threads;
78 \&
79 \& ... Code that uses threads ...
80 .Ve
81 .SH EXPLANATION
82 .IX Header "EXPLANATION"
83 Checking if the current system supports threading is not simple, here is an
84 example of how to do it:
85 .PP
86 .Vb 1
87 \& use Config;
88 \&
89 \& sub CAN_THREAD {
90 \& # Threads are not reliable before 5.008001
91 \& return 0 unless $] >= 5.008001;
92 \& return 0 unless $Config{\*(Aquseithreads\*(Aq};
93 \&
94 \& # Devel::Cover currently breaks with threads
95 \& return 0 if $INC{\*(AqDevel/Cover.pm\*(Aq};
96 \& return 1;
97 \& }
98 .Ve
99 .PP
100 Duplicating this non\-trivial code in all tests that need to use threads is
101 error\-prone. It is easy to forget bits, or get it wrong. On top of these checks you
102 also need to tell the harness that no tests should run and why.
103 .SH "SEE ALSO"
104 .IX Header "SEE ALSO"
105 .IP Test2::Require::Fork 4
106 .IX Item "Test2::Require::Fork"
107 Skip the test file if the system does not support forking.
108 .IP Test2 4
109 .IX Item "Test2"
110 Test2::Require::Threads uses Test2 under the hood.
111 .SH SOURCE
112 .IX Header "SOURCE"
113 The source code repository for Test2\-Suite can be found at
114 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
115 .SH MAINTAINERS
116 .IX Header "MAINTAINERS"
117 .IP "Chad Granum <[email protected]>" 4
118 .IX Item "Chad Granum <[email protected]>"
119 .SH AUTHORS
120 .IX Header "AUTHORS"
121 .IP "Chad Granum <[email protected]>" 4
122 .IX Item "Chad Granum <[email protected]>"
123 .SH COPYRIGHT
124 .IX Header "COPYRIGHT"
125 Copyright Chad Granum <[email protected]>.
126 .PP
127 This program is free software; you can redistribute it and/or
128 modify it under the same terms as Perl itself.
129 .PP
130 See \fIhttp://dev.perl.org/licenses/\fR