Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::Manual::Anatomy::API.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::Manual::Anatomy::API 3pm"
61 .TH Test2::Manual::Anatomy::API 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::Manual::Anatomy::API \- Internals documentation for the API.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This document covers some of the internals of Test2::API.
71 .SH "IMPLEMENTATION DETAILS"
72 .IX Header "IMPLEMENTATION DETAILS"
73 .SS Test2::API
74 .IX Subsection "Test2::API"
75 Test2::API provides a functional interface to any test2 global state. This
76 API should be preserved regardless of internal details of how and where the
77 global state is stored.
78 .PP
79 This module itself does not store any state (with a few minor exceptions) but
80 instead relies on Test2::API::Instance to store state. This module is really
81 intended to be the layer between the consumer and the implementation details.
82 Ideally the implementation details can change any way they like, and this
83 module can be updated to use the new details without breaking anything.
84 .SS Test2::API::Instance
85 .IX Subsection "Test2::API::Instance"
86 Test2::API::Instance is where the global state is actually managed. This is
87 an implementation detail, and should not be relied upon. It is entirely
88 possible that Test2::API::Instance could be removed completely, or changed
89 in incompatible ways. Really these details are free to change so long as
90 Test2::API is not broken.
91 .PP
92 Test2::API::Instance is fairly well documented, so no additionally
93 documentation is needed for this manual page.
94 .SH "SEE ALSO"
95 .IX Header "SEE ALSO"
96 Test2::Manual \- Primary index of the manual.
97 .SH SOURCE
98 .IX Header "SOURCE"
99 The source code repository for Test2\-Manual can be found at
100 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
101 .SH MAINTAINERS
102 .IX Header "MAINTAINERS"
103 .IP "Chad Granum <[email protected]>" 4
104 .IX Item "Chad Granum <[email protected]>"
105 .SH AUTHORS
106 .IX Header "AUTHORS"
107 .IP "Chad Granum <[email protected]>" 4
108 .IX Item "Chad Granum <[email protected]>"
109 .SH COPYRIGHT
110 .IX Header "COPYRIGHT"
111 Copyright Chad Granum <[email protected]>.
112 .PP
113 This program is free software; you can redistribute it and/or
114 modify it under the same terms as Perl itself.
115 .PP
116 See \fIhttp://dev.perl.org/licenses/\fR