-# vi:tw=72
+# XXX RULES FOR PATCHING THIS FILE XXX
+# Patches that fix typos or formatting are acceptable. Patches
+# that change semantics are not acceptable without prior approval
+# by David Golden or Ricardo Signes.
+
use 5.006;
use strict;
use warnings;
package CPAN::Meta::Spec;
-our $VERSION = '2.131560'; # VERSION
+our $VERSION = '2.140640'; # VERSION
1;
# ABSTRACT: specification for CPAN distribution metadata
+
+# vi:tw=72
+
__END__
=pod
-=encoding utf-8
+=encoding UTF-8
=head1 NAME
=head1 VERSION
-version 2.131560
+version 2.140640
=head1 SYNOPSIS
keywords => [ qw/ toolchain cpan dual-life / ],
'meta-spec' => {
version => '2',
- url => 'http://search.cpan.org/perldoc?CPAN::Meta::Spec',
+ url => 'https://metacpan.org/pod/CPAN::Meta::Spec',
},
generated_by => 'Module::Build version 0.36',
};
license => [ 'perl_5' ]
- license => [ 'apache_2', 'mozilla_1_0' ]
+ license => [ 'apache_2_0', 'mozilla_1_0' ]
(Spec 2) [required] {List of one or more License Strings}
the given version. This is strictly for human-consumption and should
not impact the interpretation of the document.
+For the version 2 spec, either of these are recommended:
+
+=over 4
+
+=item *
+
+C<https://metacpan.org/pod/CPAN::Meta::Spec>
+
+=item *
+
+C<http://search.cpan.org/perldoc?CPAN::Meta::Spec>
+
+=back
+
=back
=head3 name
This field is the name of the distribution. This is often created by
taking the "main package" in the distribution and changing C<::> to
C<->, but the name may be completely unrelated to the packages within
-the distribution. C.f. L<http://search.cpan.org/dist/libwww-perl/>.
+the distribution. For example, L<LWP::UserAgent> is distributed as part
+of the distribution name "libwww-perl".
=head3 release_status
distribution to specify a dependency on an optional feature of another
dependency, the use of C<optional_feature> is discouraged. Instead,
create a separate, installable distribution that ensures the desired
-feature is available. For example, if C<Foo::Bar> has a "Baz" feature,
+feature is available. For example, if C<Foo::Bar> has a C<Baz> feature,
release a separate C<Foo-Bar-Baz> distribution that satisfies
requirements for the feature.
provides => {
'Foo::Bar' => {
file => 'lib/Foo/Bar.pm',
- version => 0.27_02
+ version => '0.27_02',
},
'Foo::Bar::Blah' => {
file => 'lib/Foo/Bar/Blah.pm',
},
'Foo::Bar::Baz' => {
file => 'lib/Foo/Bar/Baz.pm',
- version => 0.3,
+ version => '0.3',
},
}
This describes all packages provided by this distribution. This
information is used by distribution and automation mechanisms like
-PAUSE, CPAN, and search.cpan.org to build indexes saying in which
-distribution various packages can be found.
+PAUSE, CPAN, metacpan.org and search.cpan.org to build indexes saying in
+which distribution various packages can be found.
The keys of C<provides> are package names that can be found within
the distribution. If a package name key is provided, it must
Because a url like C<http://myrepo.example.com/> is ambiguous as to
type, producers should provide a C<type> whenever a C<url> key is given.
The C<type> field should be the name of the most common program used
-to work with the repository, e.g. git, svn, cvs, darcs, bzr or hg.
+to work with the repository, e.g. C<git>, C<svn>, C<cvs>, C<darcs>,
+C<bzr> or C<hg>.
=back
Another subtle error that can occur in resolving prerequisites comes from
the way that modules in prerequisites are indexed to distribution files on
CPAN. When a module is deleted from a distribution, prerequisites calling
-for that module could indicate an older distribution should installed,
+for that module could indicate an older distribution should be installed,
potentially overwriting files from a newer distribution.
For example, as of Oct 31, 2009, the CPAN index file contained these
=head1 SEE ALSO
-CPAN, L<http://www.cpan.org/>
-
-CPAN.pm, L<http://search.cpan.org/dist/CPAN/>
-
-CPANPLUS, L<http://search.cpan.org/dist/CPANPLUS/>
-
-ExtUtils::MakeMaker, L<http://search.cpan.org/dist/ExtUtils-MakeMaker/>
-
-Module::Build, L<http://search.cpan.org/dist/Module-Build/>
-
-Module::Install, L<http://search.cpan.org/dist/Module-Install/>
-
-JSON, L<http://json.org/>
-
-YAML, L<http://www.yaml.org/>
-
-=head1 CONTRIBUTORS
-
-Ken Williams wrote the original CPAN Meta Spec (also known as the
-"META.yml spec") in 2003 and maintained it through several revisions
-with input from various members of the community. In 2005, Randy
-Sims redrafted it from HTML to POD for the version 1.2 release. Ken
-continued to maintain the spec through version 1.4.
-
-In late 2009, David Golden organized the version 2 proposal review
-process. David and Ricardo Signes drafted the final version 2 spec
-in April 2010 based on the version 1.4 spec and patches contributed
-during the proposal process.
-
-Several others have contributed patches over the years. The full list
-of contributors in the repository history currently includes:
-
- 2shortplanks
- Avar Arnfjord Bjarmason
- Christopher J. Madsen
- Damyan Ivanov
- David Golden
- Eric Wilhelm
- Ken Williams
- Lars DIECKOW
- Michael G. Schwern
- Randy Sims
- Ricardo Signes
-
-=head1 AUTHORS
-
-=over 4
-
-=item *
-
-David Golden <dagolden@cpan.org>
-
-=item *
-
-Ricardo Signes <rjbs@cpan.org>
-
-=back
-
-=head1 CONTRIBUTORS
-
=over 4
=item *
-Ansgar Burchardt <ansgar@cpan.org>
-
-=item *
-
-Avar Arnfjord Bjarmason <avar@cpan.org>
+CPAN, L<http://www.cpan.org/>
=item *
-Christopher J. Madsen <cjm@cpan.org>
+JSON, L<http://json.org/>
=item *
-Cory G Watson <gphat@cpan.org>
+YAML, L<http://www.yaml.org/>
=item *
-Damyan Ivanov <dam@cpan.org>
+L<CPAN>
=item *
-Eric Wilhelm <ewilhelm@cpan.org>
+L<CPANPLUS>
=item *
-Gregor Hermann <gregoa@debian.org>
+L<ExtUtils::MakeMaker>
=item *
-Ken Williams <kwilliams@cpan.org>
+L<Module::Build>
=item *
-Kenichi Ishigaki <ishigaki@cpan.org>
+L<Module::Install>
-=item *
+=back
-Lars Dieckow <daxim@cpan.org>
+=head1 HISTORY
-=item *
+Ken Williams wrote the original CPAN Meta Spec (also known as the
+"META.yml spec") in 2003 and maintained it through several revisions
+with input from various members of the community. In 2005, Randy
+Sims redrafted it from HTML to POD for the version 1.2 release. Ken
+continued to maintain the spec through version 1.4.
-Leon Timmermans <leont@cpan.org>
+In late 2009, David Golden organized the version 2 proposal review
+process. David and Ricardo Signes drafted the final version 2 spec
+in April 2010 based on the version 1.4 spec and patches contributed
+during the proposal process.
-=item *
+=head1 AUTHORS
-Mark Fowler <markf@cpan.org>
+=over 4
=item *
-Michael G. Schwern <mschwern@cpan.org>
+David Golden <dagolden@cpan.org>
=item *
-Randy Sims <randys@thepierianspring.org>
+Ricardo Signes <rjbs@cpan.org>
=back