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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
.\" -*- 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::History 3perl"
.TH CPAN::Meta::History 3perl 2024-05-30 "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::History \- history of CPAN Meta Spec changes
.SH VERSION
.IX Header "VERSION"
version 2.150010
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The CPAN Meta Spec has gone through several iterations. It was
originally written in HTML and later revised into POD (though published
in HTML generated from the POD). Fields were added, removed or changed,
sometimes by design and sometimes to reflect real-world usage after the
fact.
.PP
This document reconstructs the history of the CPAN Meta Spec based on
change logs, repository commit messages and the published HTML files.
In some cases, particularly prior to version 1.2, the exact version
when certain fields were introduced or changed is inconsistent between
sources. When in doubt, the published HTML files for versions 1.0 to
1.4 as they existed when version 2 was developed are used as the
definitive source.
.PP
Starting with version 2, the specification document is part of the
CPAN-Meta distribution and will be published on CPAN as
CPAN::Meta::Spec.
.PP
Going forward, specification version numbers will be integers and
decimal portions will correspond to a release date for the CPAN::Meta
library.
.SH HISTORY
.IX Header "HISTORY"
.SS "Version 2"
.IX Subsection "Version 2"
April 2010
.IP \(bu 4
Revised spec examples as perl data structures rather than YAML
.IP \(bu 4
Switched to JSON serialization from YAML
.IP \(bu 4
Specified allowed version number formats
.IP \(bu 4
Replaced 'requires', 'build_requires', 'configure_requires',
\&'recommends' and 'conflicts' with new 'prereqs' data structure divided
by \fIphase\fR (configure, build, test, runtime, etc.) and \fIrelationship\fR
(requires, recommends, suggests, conflicts)
.IP \(bu 4
Added support for 'develop' phase for requirements for maintaining
a list of authoring tools
.IP \(bu 4
Changed 'license' to a list and revised the set of valid licenses
.IP \(bu 4
Made 'dynamic_config' mandatory to reduce confusion
.IP \(bu 4
Changed 'resources' subkey 'repository' to a hash that clarifies
repository type, url for browsing and url for checkout
.IP \(bu 4
Changed 'resources' subkey 'bugtracker' to a hash for either web
or mailto resource
.IP \(bu 4
Changed specification of 'optional_features':
.RS 4
.IP \(bu 4
Added formal specification and usage guide instead of just example
.IP \(bu 4
Changed to use new prereqs data structure instead of individual keys
.RE
.RS 4
.RE
.IP \(bu 4
Clarified intended use of 'author' as generalized contact list
.IP \(bu 4
Added 'release_status' field to indicate stable, testing or unstable
status to provide hints to indexers
.IP \(bu 4
Added 'description' field for a longer description of the distribution
.IP \(bu 4
Formalized use of "x_" or "X_" for all custom keys not listed in the
official spec
.SS "Version 1.4"
.IX Subsection "Version 1.4"
June 2008
.IP \(bu 4
Noted explicit support for 'perl' in prerequisites
.IP \(bu 4
Added 'configure_requires' prerequisite type
.IP \(bu 4
Changed 'optional_features'
.RS 4
.IP \(bu 4
Example corrected to show map of maps instead of list of maps
(though descriptive text said 'map' even in v1.3)
.IP \(bu 4
Removed 'requires_packages', 'requires_os' and 'excluded_os'
as valid subkeys
.RE
.RS 4
.RE
.SS "Version 1.3"
.IX Subsection "Version 1.3"
November 2006
.IP \(bu 4
Added 'no_index' subkey 'directory' and removed 'dir' to match actual
usage in the wild
.IP \(bu 4
Added a 'repository' subkey to 'resources'
.SS "Version 1.2"
.IX Subsection "Version 1.2"
August 2005
.IP \(bu 4
Re-wrote and restructured spec in POD syntax
.IP \(bu 4
Changed 'name' to be mandatory
.IP \(bu 4
Changed 'generated_by' to be mandatory
.IP \(bu 4
Changed 'license' to be mandatory
.IP \(bu 4
Added version range specifications for prerequisites
.IP \(bu 4
Added required 'abstract' field
.IP \(bu 4
Added required 'author' field
.IP \(bu 4
Added required 'meta\-spec' field to define 'version' (and 'url') of the
CPAN Meta Spec used for metadata
.IP \(bu 4
Added 'provides' field
.IP \(bu 4
Added 'no_index' field and deprecated 'private' field. 'no_index'
subkeys include 'file', 'dir', 'package' and 'namespace'
.IP \(bu 4
Added 'keywords' field
.IP \(bu 4
Added 'resources' field with subkeys 'homepage', 'license', and
\&'bugtracker'
.IP \(bu 4
Added 'optional_features' field as an alternate under 'recommends'.
Includes 'description', 'requires', 'build_requires', 'conflicts',
\&'requires_packages', 'requires_os' and 'excluded_os' as valid subkeys
.IP \(bu 4
Removed 'license_uri' field
.SS "Version 1.1"
.IX Subsection "Version 1.1"
May 2003
.IP \(bu 4
Changed 'version' to be mandatory
.IP \(bu 4
Added 'private' field
.IP \(bu 4
Added 'license_uri' field
.SS "Version 1.0"
.IX Subsection "Version 1.0"
March 2003
.IP \(bu 4
Original release (in HTML format only)
.IP \(bu 4
Included 'name', 'version', 'license', 'distribution_type', 'requires',
\&'recommends', 'build_requires', 'conflicts', 'dynamic_config',
\&'generated_by'
.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.
|
