Debian Codegraph @

upstream/mageia-cauldron/man3pm/CPAN::Meta::History::Meta_1_4.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::Meta_1_4 3pm"
61 .TH CPAN::Meta::History::Meta_1_4 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::Meta_1_4 \- Version 1.4 metadata specification for META.yml
68 .SH PREFACE
69 .IX Header "PREFACE"
70 This is a historical copy of the version 1.4 specification for \fIMETA.yml\fR
71 files, copyright by Ken Williams and licensed under the same terms as Perl
72 itself.
73 .PP
74 Modifications from the original:
75 .IP \(bu 4
76 Various spelling corrections
77 .IP \(bu 4
78 Include list of valid licenses from Module::Build 0.2807 rather than
79 linking to the module, with minor updates to text and links to reflect
80 versions at the time of publication.
81 .IP \(bu 4
82 Fixed some dead links to point to active resources.
83 .SH SYNOPSIS
84 .IX Header "SYNOPSIS"
85 .Vb 10
86 \& \-\-\- #YAML:1.0
87 \& name: Module\-Build
88 \& abstract: Build and install Perl modules
89 \& version: 0.20
90 \& author:
91 \& \- Ken Williams <[email protected]>
92 \& license: perl
93 \& distribution_type: module
94 \& requires:
95 \& Config: 0
96 \& Cwd: 0
97 \& Data::Dumper: 0
98 \& ExtUtils::Install: 0
99 \& File::Basename: 0
100 \& File::Compare: 0
101 \& File::Copy: 0
102 \& File::Find: 0
103 \& File::Path: 0
104 \& File::Spec: 0
105 \& IO::File: 0
106 \& perl: 5.005_03
107 \& recommends:
108 \& Archive::Tar: 1.00
109 \& ExtUtils::Install: 0.3
110 \& ExtUtils::ParseXS: 2.02
111 \& Pod::Text: 0
112 \& YAML: 0.35
113 \& build_requires:
114 \& Test: 0
115 \& resources:
116 \& license: http://dev.perl.org/licenses/
117 \& meta\-spec:
118 \& version: 1.4
119 \& url: http://module\-build.sourceforge.net/META\-spec\-v1.3.html
120 \& generated_by: Module::Build version 0.20
121 .Ve
122 .SH DESCRIPTION
123 .IX Header "DESCRIPTION"
124 This document describes version 1.4 of the \fIMETA.yml\fR specification.
125 .PP
126 The \fIMETA.yml\fR file describes important properties of contributed
127 Perl distributions such as the ones found on CPAN. It is typically
128 created by tools like Module::Build, Module::Install, and
129 ExtUtils::MakeMaker.
130 .PP
131 The fields in the \fIMETA.yml\fR file are meant to be helpful for people
132 maintaining module collections (like CPAN), for people writing
133 installation tools (like CPAN.pm or CPANPLUS), or just for people who
134 want to know some stuff about a distribution before downloading it and
135 starting to install it.
136 .PP
137 \&\fINote: The latest stable version of this specification can always be
138 found at <http://module\-build.sourceforge.net/META\-spec\-current.html>,
139 and the latest development version (which may include things that
140 won\*(Aqt make it into the stable version) can always be found at
141 <http://module\-build.sourceforge.net/META\-spec\-blead.html>.\fR
142 .SH FORMAT
143 .IX Header "FORMAT"
144 \&\fIMETA.yml\fR files are written in the YAML format (see
145 <http://www.yaml.org/>).
146 .PP
147 See the following links to learn why we chose YAML instead of, say,
148 XML or Data::Dumper:
149 .IP \(bu 4
150 Module::Build design plans <http://www.nntp.perl.org/group/perl.makemaker/2002/04/msg407.html>
151 .IP \(bu 4
152 Not keen on YAML <http://www.nntp.perl.org/group/perl.module-authors/2003/11/msg1353.html>
153 .IP \(bu 4
154 META Concerns <http://www.nntp.perl.org/group/perl.module-authors/2003/11/msg1385.html>
155 .SH TERMINOLOGY
156 .IX Header "TERMINOLOGY"
157 .IP distribution 4
158 .IX Item "distribution"
159 This is the primary object described by the \fIMETA.yml\fR
160 specification. In the context of this document it usually refers to a
161 collection of modules, scripts, and/or documents that are distributed
162 together for other developers to use. Examples of distributions are
163 \&\f(CW\*(C`Class\-Container\*(C'\fR, \f(CW\*(C`libwww\-perl\*(C'\fR, or \f(CW\*(C`DBI\*(C'\fR.
164 .IP module 4
165 .IX Item "module"
166 This refers to a reusable library of code typically contained in a
167 single file. Currently, we primarily talk of perl modules, but this
168 specification should be open enough to apply to other languages as
169 well (ex. python, ruby). Examples of modules are \f(CW\*(C`Class::Container\*(C'\fR,
170 \&\f(CW\*(C`LWP::Simple\*(C'\fR, or \f(CW\*(C`DBD::File\*(C'\fR.
171 .SH HEADER
172 .IX Header "HEADER"
173 The first line of a \fIMETA.yml\fR file should be a valid YAML document
174 header like \f(CW"\-\-\- #YAML:1.0"\fR.
175 .SH FIELDS
176 .IX Header "FIELDS"
177 The rest of the \fIMETA.yml\fR file is one big YAML mapping whose keys
178 are described here.
179 .SS meta\-spec
180 .IX Subsection "meta-spec"
181 Example:
182 .PP
183 .Vb 3
184 \& meta\-spec:
185 \& version: 1.4
186 \& url: http://module\-build.sourceforge.net/META\-spec\-v1.3.html
187 .Ve
188 .PP
189 (Spec 1.1) [required] {URL} This field indicates the location of the
190 version of the META.yml specification used.
191 .SS name
192 .IX Subsection "name"
193 Example:
194 .PP
195 .Vb 1
196 \& name: Module\-Build
197 .Ve
198 .PP
199 (Spec 1.0) [required] {string} The name of the distribution which is often
200 created by taking the "main module" in the distribution and changing
201 "::" to "\-". Sometimes it\*(Aqs completely different, however, as in the
202 case of the libwww\-perl distribution (see
203 <http://search.cpan.org/dist/libwww\-perl/>).
204 .SS version
205 .IX Subsection "version"
206 Example:
207 .PP
208 .Vb 1
209 \& version: 0.20
210 .Ve
211 .PP
212 (Spec 1.0) [required] {version} The version of the distribution to which the
213 \&\fIMETA.yml\fR file refers.
214 .SS abstract
215 .IX Subsection "abstract"
216 Example:
217 .PP
218 .Vb 1
219 \& abstract: Build and install Perl modules.
220 .Ve
221 .PP
222 (Spec 1.1) [required] {string} A short description of the purpose of the
223 distribution.
224 .SS author
225 .IX Subsection "author"
226 Example:
227 .PP
228 .Vb 2
229 \& author:
230 \& \- Ken Williams <[email protected]>
231 .Ve
232 .PP
233 (Spec 1.1) [required] {list of strings} A YAML sequence indicating the author(s) of the
234 distribution. The preferred form is author\-name <email\-address>.
235 .SS license
236 .IX Subsection "license"
237 Example:
238 .PP
239 .Vb 1
240 \& license: perl
241 .Ve
242 .PP
243 (Spec 1.0) [required] {string} The license under which this
244 distribution may be used and redistributed.
245 .PP
246 Must be one of the following licenses:
247 .IP apache 4
248 .IX Item "apache"
249 The distribution is licensed under the Apache Software License version 1.1
250 (<http://opensource.org/licenses/Apache\-1.1>).
251 .IP artistic 4
252 .IX Item "artistic"
253 The distribution is licensed under the Artistic License version 1, as specified
254 by the Artistic file in the standard perl distribution
255 (<http://opensource.org/licenses/Artistic\-Perl\-1.0>).
256 .IP bsd 4
257 .IX Item "bsd"
258 The distribution is licensed under the BSD 3\-Clause License
259 (<http://opensource.org/licenses/BSD\-3\-Clause>).
260 .IP gpl 4
261 .IX Item "gpl"
262 The distribution is distributed under the terms of the GNU General Public
263 License version 2 (<http://opensource.org/licenses/GPL\-2.0>).
264 .IP lgpl 4
265 .IX Item "lgpl"
266 The distribution is distributed under the terms of the GNU Lesser General
267 Public License version 2 (<http://opensource.org/licenses/LGPL\-2.1>).
268 .IP mit 4
269 .IX Item "mit"
270 The distribution is licensed under the MIT License
271 (<http://opensource.org/licenses/MIT>).
272 .IP mozilla 4
273 .IX Item "mozilla"
274 The distribution is licensed under the Mozilla Public License.
275 (<http://opensource.org/licenses/MPL\-1.0> or
276 <http://opensource.org/licenses/MPL\-1.1>)
277 .IP open_source 4
278 .IX Item "open_source"
279 The distribution is licensed under some other Open Source Initiative\-approved
280 license listed at <http://www.opensource.org/licenses/>.
281 .IP perl 4
282 .IX Item "perl"
283 The distribution may be copied and redistributed under the same terms as perl
284 itself (this is by far the most common licensing option for modules on CPAN).
285 This is a dual license, in which the user may choose between either the GPL or
286 the Artistic license.
287 .IP restrictive 4
288 .IX Item "restrictive"
289 The distribution may not be redistributed without special permission from the
290 author and/or copyright holder.
291 .IP unrestricted 4
292 .IX Item "unrestricted"
293 The distribution is licensed under a license that is not approved by
294 www.opensource.org <http://www.opensource.org/> but that allows distribution
295 without restrictions.
296 .SS distribution_type
297 .IX Subsection "distribution_type"
298 Example:
299 .PP
300 .Vb 1
301 \& distribution_type: module
302 .Ve
303 .PP
304 (Spec 1.0) [optional] {string} What kind of stuff is contained in this
305 distribution. Most things on CPAN are \f(CW\*(C`module\*(C'\fRs (which can also mean
306 a collection of modules), but some things are \f(CW\*(C`script\*(C'\fRs.
307 .PP
308 Unfortunately this field is basically meaningless, since many
309 distributions are hybrids of several kinds of things, or some new
310 thing, or subjectively different in focus depending on who\*(Aqs using
311 them. Tools like Module::Build and MakeMaker will likely stop
312 generating this field.
313 .SS requires
314 .IX Subsection "requires"
315 Example:
316 .PP
317 .Vb 3
318 \& requires:
319 \& Data::Dumper: 0
320 \& File::Find: 1.03
321 .Ve
322 .PP
323 (Spec 1.0) [optional] {map} A YAML mapping indicating the Perl
324 prerequisites this distribution requires for proper operation. The
325 keys are the names of the prerequisites (module names or \*(Aqperl\*(Aq), and
326 the values are version specifications as described in VERSION
327 SPECIFICATIONS.
328 .SS recommends
329 .IX Subsection "recommends"
330 Example:
331 .PP
332 .Vb 3
333 \& recommends:
334 \& Data::Dumper: 0
335 \& File::Find: 1.03
336 .Ve
337 .PP
338 (Spec 1.0) [optional] {map} A YAML mapping indicating the Perl
339 prerequisites this distribution recommends for enhanced operation.
340 The keys are the names of the prerequisites (module names or \*(Aqperl\*(Aq),
341 and the values are version specifications as described in VERSION
342 SPECIFICATIONS.
343 .PP
344 \&\fIALTERNATIVE: It may be desirable to present to the user which
345 features depend on which modules so they can make an informed decision
346 about which recommended modules to install.\fR
347 .PP
348 Example:
349 .PP
350 .Vb 6
351 \& optional_features:
352 \& foo:
353 \& description: Provides the ability to blah.
354 \& requires:
355 \& Data::Dumper: 0
356 \& File::Find: 1.03
357 .Ve
358 .PP
359 \&\fI(Spec 1.1) [optional] {map} A YAML mapping of names for optional features
360 which are made available when its requirements are met. For each
361 feature a description is provided along with any of "requires",
362 "build_requires", and "conflicts", which have the same meaning in
363 this subcontext as described elsewhere in this document.\fR
364 .SS build_requires
365 .IX Subsection "build_requires"
366 Example:
367 .PP
368 .Vb 3
369 \& build_requires:
370 \& Data::Dumper: 0
371 \& File::Find: 1.03
372 .Ve
373 .PP
374 (Spec 1.0) [optional] {map} A YAML mapping indicating the Perl
375 prerequisites required for building and/or testing of this
376 distribution. The keys are the names of the prerequisites (module
377 names or \*(Aqperl\*(Aq), and the values are version specifications as
378 described in "VERSION SPECIFICATIONS". These dependencies are not
379 required after the distribution is installed.
380 .SS configure_requires
381 .IX Subsection "configure_requires"
382 Example:
383 .PP
384 .Vb 4
385 \& configure_requires:
386 \& Module::Build: 0.2809
387 \& Data::Dumper: 0
388 \& File::Find: 1.03
389 .Ve
390 .PP
391 (Spec 1.4) [optional] {map} A YAML mapping indicating the Perl prerequisites
392 required before configuring this distribution. The keys are the
393 names of the prerequisites (module names or \*(Aqperl\*(Aq), and the values are version
394 specifications as described in "VERSION SPECIFICATIONS". These
395 dependencies are not required after the distribution is installed.
396 .SS conflicts
397 .IX Subsection "conflicts"
398 Example:
399 .PP
400 .Vb 3
401 \& conflicts:
402 \& Data::Dumper: 0
403 \& File::Find: 1.03
404 .Ve
405 .PP
406 (Spec 1.0) [optional] {map} A YAML mapping indicating any items that
407 cannot be installed while this distribution is installed. This is a
408 pretty uncommon situation. The keys for \f(CW\*(C`conflicts\*(C'\fR are the item
409 names (module names or \*(Aqperl\*(Aq), and the values are version
410 specifications as described in "VERSION SPECIFICATIONS".
411 .SS dynamic_config
412 .IX Subsection "dynamic_config"
413 Example:
414 .PP
415 .Vb 1
416 \& dynamic_config: 0
417 .Ve
418 .PP
419 (Spec 1.0) [optional] {boolean} A boolean flag indicating whether a \fIBuild.PL\fR
420 or \fIMakefile.PL\fR (or similar) must be executed when building this
421 distribution, or whether it can be built, tested and installed solely
422 from consulting its
423 metadata file. The main reason to set this to a true value is that
424 your module performs some dynamic configuration (asking questions,
425 sensing the environment, etc.) as part of its build/install process.
426 .PP
427 Currently Module::Build doesn\*(Aqt actually do anything with this flag
428 \&\- it\*(Aqs probably going to be up to higher\-level tools like CPAN
429 to do something useful with it. It can potentially bring lots of
430 security, packaging, and convenience improvements.
431 .PP
432 If this field is omitted, it defaults to 1 (true).
433 .SS private
434 .IX Subsection "private"
435 \&\fI(Deprecated)\fR (Spec 1.0) [optional] {map} This field has been renamed to
436 "no_index". See below.
437 .SS provides
438 .IX Subsection "provides"
439 Example:
440 .PP
441 .Vb 9
442 \& provides:
443 \& Foo::Bar:
444 \& file: lib/Foo/Bar.pm
445 \& version: 0.27_02
446 \& Foo::Bar::Blah:
447 \& file: lib/Foo/Bar/Blah.pm
448 \& Foo::Bar::Baz:
449 \& file: lib/Foo/Bar/Baz.pm
450 \& version: 0.3
451 .Ve
452 .PP
453 (Spec 1.1) [optional] {map} A YAML mapping that describes all packages
454 provided by this distribution. This information can be (and, in some
455 cases, is) used by distribution and automation mechanisms like PAUSE,
456 CPAN, and search.cpan.org to build indexes saying in which
457 distribution various packages can be found.
458 .PP
459 When using tools like Module::Build that can generate the
460 \&\f(CW\*(C`provides\*(C'\fR mapping for your distribution automatically, make sure you
461 examine what it generates to make sure it makes sense \- indexers will
462 usually trust the \f(CW\*(C`provides\*(C'\fR field if it\*(Aqs present, rather than
463 scanning through the distribution files themselves to figure out
464 packages and versions. This is a good thing, because it means you can
465 use the \f(CW\*(C`provides\*(C'\fR field to tell the indexers precisely what you want
466 indexed about your distribution, rather than relying on them to
467 essentially guess what you want indexed.
468 .SS no_index
469 .IX Subsection "no_index"
470 Example:
471 .PP
472 .Vb 9
473 \& no_index:
474 \& file:
475 \& \- My/Module.pm
476 \& directory:
477 \& \- My/Private
478 \& package:
479 \& \- My::Module::Stuff
480 \& namespace:
481 \& \- My::Module::Stuff
482 .Ve
483 .PP
484 (Spec 1.1) [optional] {map} A YAML mapping that describes any files,
485 directories, packages, and namespaces that are private
486 (i.e. implementation artifacts) that are not of interest to searching
487 and indexing tools. This is useful when no \f(CW\*(C`provides\*(C'\fR field is
488 present.
489 .PP
490 For example, <http://search.cpan.org/> excludes items listed in \f(CW\*(C`no_index\*(C'\fR
491 when searching for POD, meaning files in these directories will not
492 converted to HTML and made public \- which is useful if you have
493 example or test PODs that you don\*(Aqt want the search engine to go
494 through.
495 .PP
496 \fIfile\fR
497 .IX Subsection "file"
498 .PP
499 (Spec 1.1) [optional] Exclude any listed file(s).
500 .PP
501 \fIdirectory\fR
502 .IX Subsection "directory"
503 .PP
504 (Spec 1.1) [optional] Exclude anything below the listed
505 directory(ies).
506 .PP
507 [Note: previous editions of the spec had \f(CW\*(C`dir\*(C'\fR instead of
508 \&\f(CW\*(C`directory\*(C'\fR, but I think MakeMaker and various users started using
509 \&\f(CW\*(C`directory\*(C'\fR, so in deference we switched to that.]
510 .PP
511 \fIpackage\fR
512 .IX Subsection "package"
513 .PP
514 (Spec 1.1) [optional] Exclude the listed package(s).
515 .PP
516 \fInamespace\fR
517 .IX Subsection "namespace"
518 .PP
519 (Spec 1.1) [optional] Excludes anything below the listed namespace(s),
520 but \fInot\fR the listed namespace(s) its self.
521 .SS keywords
522 .IX Subsection "keywords"
523 Example:
524 .PP
525 .Vb 4
526 \& keywords:
527 \& \- make
528 \& \- build
529 \& \- install
530 .Ve
531 .PP
532 (Spec 1.1) [optional] {list} A sequence of keywords/phrases that describe
533 this distribution.
534 .SS resources
535 .IX Subsection "resources"
536 Example:
537 .PP
538 .Vb 6
539 \& resources:
540 \& license: http://dev.perl.org/licenses/
541 \& homepage: http://sourceforge.net/projects/module\-build
542 \& bugtracker: http://rt.cpan.org/NoAuth/Bugs.html?Dist=Module\-Build
543 \& repository: http://sourceforge.net/cvs/?group_id=45731
544 \& MailingList: http://lists.sourceforge.net/lists/listinfo/module\-build\-general
545 .Ve
546 .PP
547 (Spec 1.1) [optional] {map} A mapping of any URL resources related to
548 this distribution. All\-lower\-case keys, such as \f(CW\*(C`homepage\*(C'\fR,
549 \&\f(CW\*(C`license\*(C'\fR, and \f(CW\*(C`bugtracker\*(C'\fR, are reserved by this specification, as
550 they have "official" meanings defined here in this specification. If
551 you\*(Aqd like to add your own "special" entries (like the "MailingList"
552 entry above), use at least one upper\-case letter.
553 .PP
554 The current set of official keys is:
555 .IP homepage 2
556 .IX Item "homepage"
557 The official home of this project on the web.
558 .IP license 2
559 .IX Item "license"
560 An URL for an official statement of this distribution\*(Aqs license.
561 .IP bugtracker 2
562 .IX Item "bugtracker"
563 An URL for a bug tracker (e.g. Bugzilla or RT queue) for this project.
564 .SS generated_by
565 .IX Subsection "generated_by"
566 Example:
567 .PP
568 .Vb 1
569 \& generated_by: Module::Build version 0.20
570 .Ve
571 .PP
572 (Spec 1.0) [required] {string} Indicates the tool that was used to create this
573 \&\fIMETA.yml\fR file. It\*(Aqs good form to include both the name of the tool
574 and its version, but this field is essentially opaque, at least for
575 the moment. If \fIMETA.yml\fR was generated by hand, it is suggested that
576 the author be specified here.
577 .PP
578 [Note: My \fImeta_stats.pl\fR script which I use to gather statistics
579 regarding \fIMETA.yml\fR usage prefers the form listed above, i.e. it
580 splits on /\es+version\es+/ taking the first field as the name of the
581 tool that generated the file and the second field as version of that
582 tool. RWS]
583 .SH "VERSION SPECIFICATIONS"
584 .IX Header "VERSION SPECIFICATIONS"
585 Some fields require a version specification (ex. "requires",
586 "recommends", "build_requires", etc.) to indicate the particular
587 version(s) of some other module that may be required as a
588 prerequisite. This section details the version specification formats
589 that are currently supported.
590 .PP
591 The simplest format for a version specification is just the version
592 number itself, e.g. \f(CW2.4\fR. This means that \fBat least\fR version 2.4
593 must be present. To indicate that \fBany\fR version of a prerequisite is
594 okay, even if the prerequisite doesn\*(Aqt define a version at all, use
595 the version \f(CW0\fR.
596 .PP
597 You may also use the operators < (less than), <= (less than or
598 equal), > (greater than), >= (greater than or equal), ==
599 (equal), and != (not equal). For example, the specification \f(CW<
600 2.0\fR means that any version of the prerequisite less than 2.0 is
601 suitable.
602 .PP
603 For more complicated situations, version specifications may be AND\-ed
604 together using commas. The specification \f(CW>= 1.2, != 1.5, <
605 2.0\fR indicates a version that must be \fBat least\fR 1.2, \fBless than\fR
606 2.0, and \fBnot equal to\fR 1.5.
607 .SH "SEE ALSO"
608 .IX Header "SEE ALSO"
609 CPAN <http://www.cpan.org/>
610 .PP
611 CPAN.pm
612 .PP
613 CPANPLUS
614 .PP
615 Data::Dumper
616 .PP
617 ExtUtils::MakeMaker
618 .PP
619 Module::Build
620 .PP
621 Module::Install
622 .PP
623 XML <http://www.w3.org/XML/>
624 .PP
625 YAML <http://www.yaml.org/>
626 .SH HISTORY
627 .IX Header "HISTORY"
628 .IP "March 14, 2003 (Pi day)" 4
629 .IX Item "March 14, 2003 (Pi day)"
630 .RS 4
631 .PD 0
632 .IP \(bu 2
633 .PD
634 Created version 1.0 of this document.
635 .RE
636 .RS 4
637 .RE
638 .IP "May 8, 2003" 4
639 .IX Item "May 8, 2003"
640 .RS 4
641 .PD 0
642 .IP \(bu 2
643 .PD
644 Added the "dynamic_config" field, which was missing from the initial
645 version.
646 .RE
647 .RS 4
648 .RE
649 .IP "November 13, 2003" 4
650 .IX Item "November 13, 2003"
651 .RS 4
652 .PD 0
653 .IP \(bu 2
654 .PD
655 Added more YAML rationale articles.
656 .IP \(bu 2
657 Fixed existing link to YAML discussion thread to point to new
658 <http://nntp.x.perl.org/group/> site.
659 .IP \(bu 2
660 Added and deprecated the "private" field.
661 .IP \(bu 2
662 Added "abstract", \f(CW\*(C`configure\*(C'\fR, \f(CW\*(C`requires_packages\*(C'\fR,
663 \&\f(CW\*(C`requires_os\*(C'\fR, \f(CW\*(C`excludes_os\*(C'\fR, and "no_index" fields.
664 .IP \(bu 2
665 Bumped version.
666 .RE
667 .RS 4
668 .RE
669 .IP "November 16, 2003" 4
670 .IX Item "November 16, 2003"
671 .RS 4
672 .PD 0
673 .IP \(bu 2
674 .PD
675 Added \f(CW\*(C`generation\*(C'\fR, \f(CW\*(C`authored_by\*(C'\fR fields.
676 .IP \(bu 2
677 Add alternative proposal to the "recommends" field.
678 .IP \(bu 2
679 Add proposal for a \f(CW\*(C`requires_build_tools\*(C'\fR field.
680 .RE
681 .RS 4
682 .RE
683 .IP "December 9, 2003" 4
684 .IX Item "December 9, 2003"
685 .RS 4
686 .PD 0
687 .IP \(bu 2
688 .PD
689 Added link to latest version of this specification on CPAN.
690 .IP \(bu 2
691 Added section "VERSION SPECIFICATIONS".
692 .IP \(bu 2
693 Chang name from Module::Build::META\-spec to CPAN::META::Specification.
694 .IP \(bu 2
695 Add proposal for \f(CW\*(C`auto_regenerate\*(C'\fR field.
696 .RE
697 .RS 4
698 .RE
699 .IP "December 15, 2003" 4
700 .IX Item "December 15, 2003"
701 .RS 4
702 .PD 0
703 .IP \(bu 2
704 .PD
705 Add \f(CW\*(C`index\*(C'\fR field as a compliment to "no_index"
706 .IP \(bu 2
707 Add "keywords" field as a means to aid searching distributions.
708 .IP \(bu 2
709 Add "TERMINOLOGY" section to explain certain terms that may be
710 ambiguous.
711 .RE
712 .RS 4
713 .RE
714 .IP "July 26, 2005" 4
715 .IX Item "July 26, 2005"
716 .RS 4
717 .PD 0
718 .IP \(bu 2
719 .PD
720 Removed a bunch of items (generation, requires_build_tools,
721 requires_packages, configure, requires_os, excludes_os,
722 auto_regenerate) that have never actually been supported, but were
723 more like records of brainstorming.
724 .IP \(bu 2
725 Changed \f(CW\*(C`authored_by\*(C'\fR to "author", since that\*(Aqs always been what
726 it\*(Aqs actually called in actual \fIMETA.yml\fR files.
727 .IP \(bu 2
728 Added the "==" operator to the list of supported version\-checking
729 operators.
730 .IP \(bu 2
731 Noted that the "distribution_type" field is basically meaningless,
732 and shouldn\*(Aqt really be used.
733 .IP \(bu 2
734 Clarified "dynamic_config" a bit.
735 .RE
736 .RS 4
737 .RE
738 .IP "August 23, 2005" 4
739 .IX Item "August 23, 2005"
740 .RS 4
741 .PD 0
742 .IP \(bu 2
743 .PD
744 Removed the name \f(CW\*(C`CPAN::META::Specification\*(C'\fR, since that implies a
745 module that doesn\*(Aqt actually exist.
746 .RE
747 .RS 4
748 .RE
749 .IP "June 12, 2007" 4
750 .IX Item "June 12, 2007"
751 .RS 4
752 .PD 0
753 .IP \(bu 2
754 .PD
755 Added "configure_requires".
756 .RE
757 .RS 4
758 .RE