Debian Codegraph @

upstream/mageia-cauldron/man3pm/CPAN::Meta::History.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 "CPAN::Meta::History 3pm"
61 .TH CPAN::Meta::History 3pm 2023-12-22 "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 CPAN::Meta::History \- history of CPAN Meta Spec changes
68 .SH VERSION
69 .IX Header "VERSION"
70 version 2.150010
71 .SH DESCRIPTION
72 .IX Header "DESCRIPTION"
73 The CPAN Meta Spec has gone through several iterations. It was
74 originally written in HTML and later revised into POD (though published
75 in HTML generated from the POD). Fields were added, removed or changed,
76 sometimes by design and sometimes to reflect real\-world usage after the
77 fact.
78 .PP
79 This document reconstructs the history of the CPAN Meta Spec based on
80 change logs, repository commit messages and the published HTML files.
81 In some cases, particularly prior to version 1.2, the exact version
82 when certain fields were introduced or changed is inconsistent between
83 sources. When in doubt, the published HTML files for versions 1.0 to
84 1.4 as they existed when version 2 was developed are used as the
85 definitive source.
86 .PP
87 Starting with version 2, the specification document is part of the
88 CPAN\-Meta distribution and will be published on CPAN as
89 CPAN::Meta::Spec.
90 .PP
91 Going forward, specification version numbers will be integers and
92 decimal portions will correspond to a release date for the CPAN::Meta
93 library.
94 .SH HISTORY
95 .IX Header "HISTORY"
96 .SS "Version 2"
97 .IX Subsection "Version 2"
98 April 2010
99 .IP \(bu 4
100 Revised spec examples as perl data structures rather than YAML
101 .IP \(bu 4
102 Switched to JSON serialization from YAML
103 .IP \(bu 4
104 Specified allowed version number formats
105 .IP \(bu 4
106 Replaced \*(Aqrequires\*(Aq, \*(Aqbuild_requires\*(Aq, \*(Aqconfigure_requires\*(Aq,
107 \&\*(Aqrecommends\*(Aq and \*(Aqconflicts\*(Aq with new \*(Aqprereqs\*(Aq data structure divided
108 by \fIphase\fR (configure, build, test, runtime, etc.) and \fIrelationship\fR
109 (requires, recommends, suggests, conflicts)
110 .IP \(bu 4
111 Added support for \*(Aqdevelop\*(Aq phase for requirements for maintaining
112 a list of authoring tools
113 .IP \(bu 4
114 Changed \*(Aqlicense\*(Aq to a list and revised the set of valid licenses
115 .IP \(bu 4
116 Made \*(Aqdynamic_config\*(Aq mandatory to reduce confusion
117 .IP \(bu 4
118 Changed \*(Aqresources\*(Aq subkey \*(Aqrepository\*(Aq to a hash that clarifies
119 repository type, url for browsing and url for checkout
120 .IP \(bu 4
121 Changed \*(Aqresources\*(Aq subkey \*(Aqbugtracker\*(Aq to a hash for either web
122 or mailto resource
123 .IP \(bu 4
124 Changed specification of \*(Aqoptional_features\*(Aq:
125 .RS 4
126 .IP \(bu 4
127 Added formal specification and usage guide instead of just example
128 .IP \(bu 4
129 Changed to use new prereqs data structure instead of individual keys
130 .RE
131 .RS 4
132 .RE
133 .IP \(bu 4
134 Clarified intended use of \*(Aqauthor\*(Aq as generalized contact list
135 .IP \(bu 4
136 Added \*(Aqrelease_status\*(Aq field to indicate stable, testing or unstable
137 status to provide hints to indexers
138 .IP \(bu 4
139 Added \*(Aqdescription\*(Aq field for a longer description of the distribution
140 .IP \(bu 4
141 Formalized use of "x_" or "X_" for all custom keys not listed in the
142 official spec
143 .SS "Version 1.4"
144 .IX Subsection "Version 1.4"
145 June 2008
146 .IP \(bu 4
147 Noted explicit support for \*(Aqperl\*(Aq in prerequisites
148 .IP \(bu 4
149 Added \*(Aqconfigure_requires\*(Aq prerequisite type
150 .IP \(bu 4
151 Changed \*(Aqoptional_features\*(Aq
152 .RS 4
153 .IP \(bu 4
154 Example corrected to show map of maps instead of list of maps
155 (though descriptive text said \*(Aqmap\*(Aq even in v1.3)
156 .IP \(bu 4
157 Removed \*(Aqrequires_packages\*(Aq, \*(Aqrequires_os\*(Aq and \*(Aqexcluded_os\*(Aq
158 as valid subkeys
159 .RE
160 .RS 4
161 .RE
162 .SS "Version 1.3"
163 .IX Subsection "Version 1.3"
164 November 2006
165 .IP \(bu 4
166 Added \*(Aqno_index\*(Aq subkey \*(Aqdirectory\*(Aq and removed \*(Aqdir\*(Aq to match actual
167 usage in the wild
168 .IP \(bu 4
169 Added a \*(Aqrepository\*(Aq subkey to \*(Aqresources\*(Aq
170 .SS "Version 1.2"
171 .IX Subsection "Version 1.2"
172 August 2005
173 .IP \(bu 4
174 Re\-wrote and restructured spec in POD syntax
175 .IP \(bu 4
176 Changed \*(Aqname\*(Aq to be mandatory
177 .IP \(bu 4
178 Changed \*(Aqgenerated_by\*(Aq to be mandatory
179 .IP \(bu 4
180 Changed \*(Aqlicense\*(Aq to be mandatory
181 .IP \(bu 4
182 Added version range specifications for prerequisites
183 .IP \(bu 4
184 Added required \*(Aqabstract\*(Aq field
185 .IP \(bu 4
186 Added required \*(Aqauthor\*(Aq field
187 .IP \(bu 4
188 Added required \*(Aqmeta\-spec\*(Aq field to define \*(Aqversion\*(Aq (and \*(Aqurl\*(Aq) of the
189 CPAN Meta Spec used for metadata
190 .IP \(bu 4
191 Added \*(Aqprovides\*(Aq field
192 .IP \(bu 4
193 Added \*(Aqno_index\*(Aq field and deprecated \*(Aqprivate\*(Aq field. \*(Aqno_index\*(Aq
194 subkeys include \*(Aqfile\*(Aq, \*(Aqdir\*(Aq, \*(Aqpackage\*(Aq and \*(Aqnamespace\*(Aq
195 .IP \(bu 4
196 Added \*(Aqkeywords\*(Aq field
197 .IP \(bu 4
198 Added \*(Aqresources\*(Aq field with subkeys \*(Aqhomepage\*(Aq, \*(Aqlicense\*(Aq, and
199 \&\*(Aqbugtracker\*(Aq
200 .IP \(bu 4
201 Added \*(Aqoptional_features\*(Aq field as an alternate under \*(Aqrecommends\*(Aq.
202 Includes \*(Aqdescription\*(Aq, \*(Aqrequires\*(Aq, \*(Aqbuild_requires\*(Aq, \*(Aqconflicts\*(Aq,
203 \&\*(Aqrequires_packages\*(Aq, \*(Aqrequires_os\*(Aq and \*(Aqexcluded_os\*(Aq as valid subkeys
204 .IP \(bu 4
205 Removed \*(Aqlicense_uri\*(Aq field
206 .SS "Version 1.1"
207 .IX Subsection "Version 1.1"
208 May 2003
209 .IP \(bu 4
210 Changed \*(Aqversion\*(Aq to be mandatory
211 .IP \(bu 4
212 Added \*(Aqprivate\*(Aq field
213 .IP \(bu 4
214 Added \*(Aqlicense_uri\*(Aq field
215 .SS "Version 1.0"
216 .IX Subsection "Version 1.0"
217 March 2003
218 .IP \(bu 4
219 Original release (in HTML format only)
220 .IP \(bu 4
221 Included \*(Aqname\*(Aq, \*(Aqversion\*(Aq, \*(Aqlicense\*(Aq, \*(Aqdistribution_type\*(Aq, \*(Aqrequires\*(Aq,
222 \&\*(Aqrecommends\*(Aq, \*(Aqbuild_requires\*(Aq, \*(Aqconflicts\*(Aq, \*(Aqdynamic_config\*(Aq,
223 \&\*(Aqgenerated_by\*(Aq
224 .SH AUTHORS
225 .IX Header "AUTHORS"
226 .IP \(bu 4
227 David Golden <[email protected]>
228 .IP \(bu 4
229 Ricardo Signes <[email protected]>
230 .IP \(bu 4
231 Adam Kennedy <[email protected]>
232 .SH "COPYRIGHT AND LICENSE"
233 .IX Header "COPYRIGHT AND LICENSE"
234 This software is copyright (c) 2010 by David Golden, Ricardo Signes, Adam Kennedy and Contributors.
235 .PP
236 This is free software; you can redistribute it and/or modify it under
237 the same terms as the Perl 5 programming language system itself.