summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3/Test::use::ok.3perl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/archlinux/man3/Test::use::ok.3perl
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/archlinux/man3/Test::use::ok.3perl')
-rw-r--r--upstream/archlinux/man3/Test::use::ok.3perl111
1 files changed, 111 insertions, 0 deletions
diff --git a/upstream/archlinux/man3/Test::use::ok.3perl b/upstream/archlinux/man3/Test::use::ok.3perl
new file mode 100644
index 00000000..6bfac029
--- /dev/null
+++ b/upstream/archlinux/man3/Test::use::ok.3perl
@@ -0,0 +1,111 @@
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
+.ie n \{\
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds C`
+. ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is >0, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+. if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\" ========================================================================
+.\"
+.IX Title "Test::use::ok 3perl"
+.TH Test::use::ok 3perl 2024-02-11 "perl v5.38.2" "Perl Programmers Reference Guide"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH NAME
+Test::use::ok \- Alternative to Test::More::use_ok
+.SH SYNOPSIS
+.IX Header "SYNOPSIS"
+.Vb 1
+\& use ok \*(AqSome::Module\*(Aq;
+.Ve
+.SH DESCRIPTION
+.IX Header "DESCRIPTION"
+According to the \fBTest::More\fR documentation, it is recommended to run
+\&\f(CWuse_ok()\fR inside a \f(CW\*(C`BEGIN\*(C'\fR block, so functions are exported at
+compile-time and prototypes are properly honored.
+.PP
+That is, instead of writing this:
+.PP
+.Vb 2
+\& use_ok( \*(AqSome::Module\*(Aq );
+\& use_ok( \*(AqOther::Module\*(Aq );
+.Ve
+.PP
+One should write this:
+.PP
+.Vb 2
+\& BEGIN { use_ok( \*(AqSome::Module\*(Aq ); }
+\& BEGIN { use_ok( \*(AqOther::Module\*(Aq ); }
+.Ve
+.PP
+However, people often either forget to add \f(CW\*(C`BEGIN\*(C'\fR, or mistakenly group
+\&\f(CW\*(C`use_ok\*(C'\fR with other tests in a single \f(CW\*(C`BEGIN\*(C'\fR block, which can create subtle
+differences in execution order.
+.PP
+With this module, simply change all \f(CW\*(C`use_ok\*(C'\fR in test scripts to \f(CW\*(C`use ok\*(C'\fR,
+and they will be executed at \f(CW\*(C`BEGIN\*(C'\fR time. The explicit space after \f(CW\*(C`use\*(C'\fR
+makes it clear that this is a single compile-time action.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+Test::More
+.SH MAINTAINER
+.IX Header "MAINTAINER"
+.IP "Chad Granum <exodist@cpan.org>" 4
+.IX Item "Chad Granum <exodist@cpan.org>"
+.SH "CC0 1.0 Universal"
+.IX Header "CC0 1.0 Universal"
+To the extent possible under law, 唐鳳 has waived all copyright and related
+or neighboring rights to Test-use-ok.
+.PP
+This work is published from Taiwan.
+.PP
+<http://creativecommons.org/publicdomain/zero/1.0>