Debian Codegraph @

upstream/debian-unstable/man3/Test2::Require::Module.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::Module 3perl"
58 .TH Test2::Require::Module 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::Module \- Skip tests if certain packages are not installed, or
65 insufficient versions.
66 .SH DESCRIPTION
67 .IX Header "DESCRIPTION"
68 Sometimes you have tests that are nice to run, but depend on tools that may not
69 be available. Instead of adding the tool as a dep, or making the test always
70 skip, it is common to make the test run conditionally. This package helps make
71 that possible.
72 .PP
73 This module is modeled after Test::Requires. The difference is that this
74 module is based on Test2 directly, and does not go through Test::Builder.
75 Another difference is that the packages you check for are not imported into
76 your namespace for you. This is intentional.
77 .SH SYNOPSIS
78 .IX Header "SYNOPSIS"
79 .Vb 2
80 \& # The test will be skipped unless Some::Module is installed, any version.
81 \& use Test2::Require::Module \*(AqSome::Module\*(Aq;
82 \&
83 \& # The test will be skipped unless \*(AqOther::Module\*(Aq is installed and at
84 \& # version \*(Aq5.555\*(Aq or greater.
85 \& use Test2::Require::Module \*(AqOther::Module\*(Aq => \*(Aq5.555\*(Aq;
86 \&
87 \& # We now need to use them directly, Test2::Require::Module does not import
88 \& # them for us.
89 \& use Some::Module;
90 \& use Other::Module;
91 .Ve
92 .SH SOURCE
93 .IX Header "SOURCE"
94 The source code repository for Test2\-Suite can be found at
95 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
96 .SH MAINTAINERS
97 .IX Header "MAINTAINERS"
98 .IP "Chad Granum <[email protected]>" 4
99 .IX Item "Chad Granum <[email protected]>"
100 .SH AUTHORS
101 .IX Header "AUTHORS"
102 .PD 0
103 .IP "Chad Granum <[email protected]>" 4
104 .IX Item "Chad Granum <[email protected]>"
105 .PD
106 .SH COPYRIGHT
107 .IX Header "COPYRIGHT"
108 Copyright 2018 Chad Granum <[email protected]>.
109 .PP
110 This program is free software; you can redistribute it and/or
111 modify it under the same terms as Perl itself.
112 .PP
113 See \fIhttp://dev.perl.org/licenses/\fR