Debian Codegraph @

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