1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
.\" -*- 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 "CPAN::Meta::Prereqs 3pm"
.TH CPAN::Meta::Prereqs 3pm 2023-11-28 "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
CPAN::Meta::Prereqs \- a set of distribution prerequisites by phase and type
.SH VERSION
.IX Header "VERSION"
version 2.150010
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A CPAN::Meta::Prereqs object represents the prerequisites for a CPAN
distribution or one of its optional features. Each set of prereqs is
organized by phase and type, as described in CPAN::Meta::Prereqs.
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
.Vb 1
\& my $prereq = CPAN::Meta::Prereqs\->new( \e%prereq_spec );
.Ve
.PP
This method returns a new set of Prereqs. The input should look like the
contents of the \f(CW\*(C`prereqs\*(C'\fR field described in CPAN::Meta::Spec, meaning
something more or less like this:
.PP
.Vb 10
\& my $prereq = CPAN::Meta::Prereqs\->new({
\& runtime => {
\& requires => {
\& \*(AqSome::Module\*(Aq => \*(Aq1.234\*(Aq,
\& ...,
\& },
\& ...,
\& },
\& ...,
\& });
.Ve
.PP
You can also construct an empty set of prereqs with:
.PP
.Vb 1
\& my $prereqs = CPAN::Meta::Prereqs\->new;
.Ve
.PP
This empty set of prereqs is useful for accumulating new prereqs before finally
dumping the whole set into a structure or string.
.SS requirements_for
.IX Subsection "requirements_for"
.Vb 1
\& my $requirements = $prereqs\->requirements_for( $phase, $type );
.Ve
.PP
This method returns a CPAN::Meta::Requirements object for the given
phase/type combination. If no prerequisites are registered for that
combination, a new CPAN::Meta::Requirements object will be returned, and it may
be added to as needed.
.PP
If \f(CW$phase\fR or \f(CW$type\fR are undefined or otherwise invalid, an exception will
be raised.
.SS phases
.IX Subsection "phases"
.Vb 1
\& my @phases = $prereqs\->phases;
.Ve
.PP
This method returns the list of all phases currently populated in the prereqs
object, suitable for iterating.
.SS types_in
.IX Subsection "types_in"
.Vb 1
\& my @runtime_types = $prereqs\->types_in(\*(Aqruntime\*(Aq);
.Ve
.PP
This method returns the list of all types currently populated in the prereqs
object for the provided phase, suitable for iterating.
.SS with_merged_prereqs
.IX Subsection "with_merged_prereqs"
.Vb 1
\& my $new_prereqs = $prereqs\->with_merged_prereqs( $other_prereqs );
\&
\& my $new_prereqs = $prereqs\->with_merged_prereqs( \e@other_prereqs );
.Ve
.PP
This method returns a new CPAN::Meta::Prereqs objects in which all the
other prerequisites given are merged into the current set. This is primarily
provided for combining a distribution's core prereqs with the prereqs of one of
its optional features.
.PP
The new prereqs object has no ties to the originals, and altering it further
will not alter them.
.SS merged_requirements
.IX Subsection "merged_requirements"
.Vb 3
\& my $new_reqs = $prereqs\->merged_requirements( \e@phases, \e@types );
\& my $new_reqs = $prereqs\->merged_requirements( \e@phases );
\& my $new_reqs = $prereqs\->merged_requirements();
.Ve
.PP
This method joins together all requirements across a number of phases
and types into a new CPAN::Meta::Requirements object. If arguments
are omitted, it defaults to "runtime", "build" and "test" for phases
and "requires" and "recommends" for types.
.SS as_string_hash
.IX Subsection "as_string_hash"
This method returns a hashref containing structures suitable for dumping into a
distmeta data structure. It is made up of hashes and strings, only; there will
be no Prereqs, CPAN::Meta::Requirements, or \f(CW\*(C`version\*(C'\fR objects inside it.
.SS is_finalized
.IX Subsection "is_finalized"
This method returns true if the set of prereqs has been marked "finalized," and
cannot be altered.
.SS finalize
.IX Subsection "finalize"
Calling \f(CW\*(C`finalize\*(C'\fR on a Prereqs object will close it for further modification.
Attempting to make any changes that would actually alter the prereqs will
result in an exception being thrown.
.SS clone
.IX Subsection "clone"
.Vb 1
\& my $cloned_prereqs = $prereqs\->clone;
.Ve
.PP
This method returns a Prereqs object that is identical to the original object,
but can be altered without affecting the original object. Finalization does
not survive cloning, meaning that you may clone a finalized set of prereqs and
then modify the clone.
.SH BUGS
.IX Header "BUGS"
Please report any bugs or feature using the CPAN Request Tracker.
Bugs can be submitted through the web interface at
<http://rt.cpan.org/Dist/Display.html?Queue=CPAN\-Meta>
.PP
When submitting a bug or request, please include a test-file or a patch to an
existing test-file that illustrates the bug or desired feature.
.SH AUTHORS
.IX Header "AUTHORS"
.IP \(bu 4
David Golden <dagolden@cpan.org>
.IP \(bu 4
Ricardo Signes <rjbs@cpan.org>
.IP \(bu 4
Adam Kennedy <adamk@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2010 by David Golden, Ricardo Signes, Adam Kennedy and Contributors.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
|
