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