Debian Codegraph @

upstream/debian-unstable/man3/Test::use::ok.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 "Test::use::ok 3perl"
58 .TH Test::use::ok 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 Test::use::ok \- Alternative to Test::More::use_ok
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& use ok \*(AqSome::Module\*(Aq;
69 .Ve
70 .SH DESCRIPTION
71 .IX Header "DESCRIPTION"
72 According to the \fBTest::More\fR documentation, it is recommended to run
73 \&\f(CWuse_ok()\fR inside a \f(CW\*(C`BEGIN\*(C'\fR block, so functions are exported at
74 compile-time and prototypes are properly honored.
75 .PP
76 That is, instead of writing this:
77 .PP
78 .Vb 2
79 \& use_ok( \*(AqSome::Module\*(Aq );
80 \& use_ok( \*(AqOther::Module\*(Aq );
81 .Ve
82 .PP
83 One should write this:
84 .PP
85 .Vb 2
86 \& BEGIN { use_ok( \*(AqSome::Module\*(Aq ); }
87 \& BEGIN { use_ok( \*(AqOther::Module\*(Aq ); }
88 .Ve
89 .PP
90 However, people often either forget to add \f(CW\*(C`BEGIN\*(C'\fR, or mistakenly group
91 \&\f(CW\*(C`use_ok\*(C'\fR with other tests in a single \f(CW\*(C`BEGIN\*(C'\fR block, which can create subtle
92 differences in execution order.
93 .PP
94 With this module, simply change all \f(CW\*(C`use_ok\*(C'\fR in test scripts to \f(CW\*(C`use ok\*(C'\fR,
95 and they will be executed at \f(CW\*(C`BEGIN\*(C'\fR time. The explicit space after \f(CW\*(C`use\*(C'\fR
96 makes it clear that this is a single compile-time action.
97 .SH "SEE ALSO"
98 .IX Header "SEE ALSO"
99 Test::More
100 .SH MAINTAINER
101 .IX Header "MAINTAINER"
102 .IP "Chad Granum <[email protected]>" 4
103 .IX Item "Chad Granum <[email protected]>"
104 .SH "CC0 1.0 Universal"
105 .IX Header "CC0 1.0 Universal"
106 To the extent possible under law, 唐鳳 has waived all copyright and related
107 or neighboring rights to Test::use::ok.
108 .PP
109 This work is published from Taiwan.
110 .PP
111 <https://creativecommons.org/publicdomain/zero/1.0/>