Debian Codegraph @

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