Debian Codegraph @

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