Debian Codegraph @

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