[Module-build-checkins] Module-Build/website META-spec.html,1.7,1.8 META-spec.pod,1.4,1.5
Status: Beta
Brought to you by:
kwilliams
Menu
▾
▴
[Module-build-checkins] Module-Build/website META-spec.html,1.7,1.8 META-spec.pod,1.4,1.5
|
From: Ken W. <kwi...@us...> - 2005-07-28 02:55:38
|
Update of /cvsroot/module-build/Module-Build/website In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv30472 Modified Files: META-spec.html META-spec.pod Log Message: Add data type information for each field, and add an example for 'resources' Index: META-spec.html =================================================================== RCS file: /cvsroot/module-build/Module-Build/website/META-spec.html,v retrieving revision 1.7 retrieving revision 1.8 diff -u -d -r1.7 -r1.8 --- META-spec.html 27 Jul 2005 04:47:53 -0000 1.7 +++ META-spec.html 28 Jul 2005 02:55:25 -0000 1.8 @@ -201,19 +201,17 @@ <h2><a name="metaspec">meta-spec</a></h2> <p>Example:</p> <pre> - meta-spec: - url: <<a href="http://search.cpan.org/dist/CPAN-META-Specification-1.1/>">http://search.cpan.org/dist/CPAN-META-Specification-1.1/></a>; - version: 1.1</pre> -<p>(Spec 1.1) [required] This mapping indicates the location of the -version of the META.yml specification used along with the version -number of that specification.</p> + meta-spec: |- + <a href="http://search.cpan.org/dist/CPAN-META-Specification-1.1/">http://search.cpan.org/dist/CPAN-META-Specification-1.1/</a></pre> +<p>(Spec 1.1) [required] {URL} This field indicates the location of the +version of the META.yml specification used.</p> <p> </p> <h2><a name="name">name</a></h2> <p>Example:</p> <pre> name: Module-Build</pre> -<p>(Spec 1.0) [required] The name of the distribution which is often +<p>(Spec 1.0) [required] {string} The name of the distribution which is often created by taking the ``main module'' in the distribution and changing ``::'' to ``-''. Sometimes it's completely different, however, as in the case of the libww-perl distribution (see @@ -224,7 +222,7 @@ <p>Example:</p> <pre> version: 0.20</pre> -<p>(Spec 1.0) [required] The version of the distribution to which the +<p>(Spec 1.0) [required] {version} The version of the distribution to which the <em>META.yml</em> file refers.</p> <p> </p> @@ -232,7 +230,7 @@ <p>Example:</p> <pre> abstract: Build and install Perl modules.</pre> -<p>(Spec 1.1) [required] A short description of the purpose of the +<p>(Spec 1.1) [required] {string} A short description of the purpose of the distribution.</p> <p> </p> @@ -241,7 +239,7 @@ <pre> author: - Ken Williams <kwi...@cp...></pre> -<p>(Spec 1.1) [required] A YAML sequence indicating the <code>author(s)</code> of the +<p>(Spec 1.1) [required] {list of strings} A YAML sequence indicating the <code>author(s)</code> of the distribution. The prefered form is author-name <email-address>.</p> <p> </p> @@ -249,7 +247,7 @@ <p>Example:</p> <pre> license: perl</pre> -<p>(Spec 1.0) [required] The license under which this distribution may be +<p>(Spec 1.0) [required] {string} The license under which this distribution may be used and redistributed. See <a href="/Module/Build.html">the Module::Build manpage</a> for the list of valid options.</p> <p> @@ -258,7 +256,7 @@ <p>Example:</p> <pre> distribution_type: module</pre> -<p>(Spec 1.0) [optional] What kind of stuff is contained in this +<p>(Spec 1.0) [optional] {string} What kind of stuff is contained in this distribution. Most things on CPAN are <a href="#item_module"><code>module</code></a>s (which can also mean a collection of modules), but some things are <code>script</code>s.</p> <p>Unfortunately this field is basically meaningless, since many @@ -274,7 +272,7 @@ requires: Data::Dumper: 0 File::Find: 1.03</pre> -<p>(Spec 1.0) [optional] A YAML mapping indicating the Perl modules this +<p>(Spec 1.0) [optional] {map} A YAML mapping indicating the Perl modules this distribution requires for proper operation. The keys are the module names, and the values are version specifications as described in <a href="/Module/Build.html">the Module::Build manpage</a> for the ``requires'' parameter.</p> @@ -286,7 +284,7 @@ recommends: Data::Dumper: 0 File::Find: 1.03</pre> -<p>(Spec 1.0) [optional] A YAML mapping indicating the Perl modules this +<p>(Spec 1.0) [optional] {map} A YAML mapping indicating the Perl modules this distribution recommends for enhanced operation.</p> <p><em>ALTERNATIVE: It may be desirable to present to the user which features depend on which modules so they can make an informed @@ -302,7 +300,7 @@ - bar: description: This feature is not available on this platform. excludes_os: MSWin32</pre> -<p><em>(Spec 1.1) [optional] A YAML sequence of names for optional features +<p><em>(Spec 1.1) [optional] {map} A YAML sequence of names for optional features which are made available when its requirements are met. For each feature a description is provided along with any of <a href="#requires">requires</a>, <a href="#build_requires">build_requires</a>, <a href="#conflicts">conflicts</a>, <a href="#requires_packages">requires_packages</a>, @@ -316,7 +314,7 @@ build_requires: Data::Dumper: 0 File::Find: 1.03</pre> -<p>(Spec 1.0) [optional] A YAML mapping indicating the Perl modules +<p>(Spec 1.0) [optional] {map} A YAML mapping indicating the Perl modules required for building and/or testing of this distribution. These dependencies are not required after the module is installed.</p> <p> @@ -327,7 +325,7 @@ conflicts: Data::Dumper: 0 File::Find: 1.03</pre> -<p>(Spec 1.0) [optional] A YAML mapping indicating the Perl modules that +<p>(Spec 1.0) [optional] {map} A YAML mapping indicating the Perl modules that cannot be installed while this distribution is installed. This is a pretty uncommon situation.</p> <p> @@ -336,7 +334,7 @@ <p>Example:</p> <pre> dynamic_config: 0</pre> -<p>(Spec 1.0) [optional] A boolean flag indicating whether a <em>Build.PL</em> +<p>(Spec 1.0) [optional] {boolean} A boolean flag indicating whether a <em>Build.PL</em> or <em>Makefile.PL</em> (or similar) must be executed when building this distribution, or whether it can be built, tested and installed solely from consulting its @@ -351,7 +349,7 @@ <p> </p> <h2><a name="private">private</a></h2> -<p><em>(Deprecated)</em> (Spec 1.0) [optional] This field has been renamed to +<p><em>(Deprecated)</em> (Spec 1.0) [optional] {map} This field has been renamed to <a href="#no_index">no_index</a>. See below.</p> <p> </p> @@ -367,7 +365,7 @@ Foo::Bar::Baz: file: lib/Foo/Bar/Baz.pm version: 0.3</pre> -<p>(Spec 1.1) [optional] A YAML mapping that describes all packages +<p>(Spec 1.1) [optional] {map} A YAML mapping that describes all packages provided by this distribution. This information can be (and, in some cases, is) used by distribution and automation mechanisms like PAUSE, CPAN, and search.cpan.org to build indexes saying in which @@ -395,7 +393,7 @@ - My::Module::Stuff namespace: - My::Module::Stuff</pre> -<p>(Spec 1.1) [optional] A YAML mapping that describes any files, +<p>(Spec 1.1) [optional] {map} A YAML mapping that describes any files, directories, packages, and namespaces that are private (i.e. implementation artifacts) that are not of interest to searching and indexing tools. This is useful when no <code>provides</code> field is @@ -427,19 +425,27 @@ <p>Example:</p> <pre> keywords: - - make - - build - - install</pre> -<p>(Spec 1.1) [optional] A sequence of keywords/phrases that describe + - make + - build + - install</pre> +<p>(Spec 1.1) [optional] {list} A sequence of keywords/phrases that describe this distribution.</p> <p> </p> <h2><a name="resources">resources</a></h2> -<p>(Spec 1.1) [optional] A mapping of any URL resources related to this -distribution. All-lower-case keys, such as <a href="#item_homepage"><code>homepage</code></a>, <a href="#item_license"><code>license</code></a>, -and <a href="#item_bugtracker"><code>bugtracker</code></a>, are reserved by this specification, as they have -``official'' uses. If you'd like to add your own ``special'' entries, use -at least one upper-case letter.</p> +<p>Example:</p> +<pre> + resources: + license: <a href="http://dev.perl.org/licenses/">http://dev.perl.org/licenses/</a> + homepage: <a href="http://sourceforge.net/projects/module-build">http://sourceforge.net/projects/module-build</a> + bugtracker: <a href="http://rt.cpan.org/NoAuth/Bugs.html?Dist=Module-Build">http://rt.cpan.org/NoAuth/Bugs.html?Dist=Module-Build</a> + MailingList: <a href="http://lists.sourceforge.net/lists/listinfo/module-build-general">http://lists.sourceforge.net/lists/listinfo/module-build-general</a></pre> +<p>(Spec 1.1) [optional] {map} A mapping of any URL resources related to +this distribution. All-lower-case keys, such as <a href="#item_homepage"><code>homepage</code></a>, +<a href="#item_license"><code>license</code></a>, and <a href="#item_bugtracker"><code>bugtracker</code></a>, are reserved by this specification, as +they have ``official'' meanings defined here in this specification. If +you'd like to add your own ``special'' entries (like the ``MailingList'' +entry above), use at least one upper-case letter.</p> <p>The current set of official keys is:</p> <dl> <dt><strong><a name="item_homepage">homepage</a></strong><br /> @@ -466,7 +472,7 @@ <p>Example:</p> <pre> generated_by: Module::Build version 0.20</pre> -<p>(Spec 1.0) [required] Indicates the tool that was used to create this +<p>(Spec 1.0) [required] {string} Indicates the tool that was used to create this <em>META.yml</em> file. It's good form to include both the name of the tool and its version, but this field is essentially opaque, at least for the moment. If <em>META.yml</em> was generated by hand, it is suggested that Index: META-spec.pod =================================================================== RCS file: /cvsroot/module-build/Module-Build/website/META-spec.pod,v retrieving revision 1.4 retrieving revision 1.5 diff -u -d -r1.4 -r1.5 --- META-spec.pod 27 Jul 2005 04:47:53 -0000 1.4 +++ META-spec.pod 28 Jul 2005 02:55:25 -0000 1.5 @@ -152,13 +152,11 @@ Example: - meta-spec: - url: <http://search.cpan.org/dist/CPAN-META-Specification-1.1/> - version: 1.1 + meta-spec: |- + http://search.cpan.org/dist/CPAN-META-Specification-1.1/ -(Spec 1.1) [required] This mapping indicates the location of the -version of the META.yml specification used along with the version -number of that specification. +(Spec 1.1) [required] {URL} This field indicates the location of the +version of the META.yml specification used. =head2 name @@ -166,7 +164,7 @@ name: Module-Build -(Spec 1.0) [required] The name of the distribution which is often +(Spec 1.0) [required] {string} The name of the distribution which is often created by taking the "main module" in the distribution and changing "::" to "-". Sometimes it's completely different, however, as in the case of the libww-perl distribution (see @@ -178,7 +176,7 @@ version: 0.20 -(Spec 1.0) [required] The version of the distribution to which the +(Spec 1.0) [required] {version} The version of the distribution to which the F<META.yml> file refers. =head2 abstract @@ -187,7 +185,7 @@ abstract: Build and install Perl modules. -(Spec 1.1) [required] A short description of the purpose of the +(Spec 1.1) [required] {string} A short description of the purpose of the distribution. =head2 author @@ -197,7 +195,7 @@ author: - Ken Williams <kwi...@cp...> -(Spec 1.1) [required] A YAML sequence indicating the author(s) of the +(Spec 1.1) [required] {list of strings} A YAML sequence indicating the author(s) of the distribution. The prefered form is author-name <email-address>. =head2 license @@ -206,7 +204,7 @@ license: perl -(Spec 1.0) [required] The license under which this distribution may be +(Spec 1.0) [required] {string} The license under which this distribution may be used and redistributed. See L<Module::Build> for the list of valid options. @@ -216,7 +214,7 @@ distribution_type: module -(Spec 1.0) [optional] What kind of stuff is contained in this +(Spec 1.0) [optional] {string} What kind of stuff is contained in this distribution. Most things on CPAN are C<module>s (which can also mean a collection of modules), but some things are C<script>s. @@ -234,7 +232,7 @@ Data::Dumper: 0 File::Find: 1.03 -(Spec 1.0) [optional] A YAML mapping indicating the Perl modules this +(Spec 1.0) [optional] {map} A YAML mapping indicating the Perl modules this distribution requires for proper operation. The keys are the module names, and the values are version specifications as described in L<Module::Build> for the "requires" parameter. @@ -247,7 +245,7 @@ Data::Dumper: 0 File::Find: 1.03 -(Spec 1.0) [optional] A YAML mapping indicating the Perl modules this +(Spec 1.0) [optional] {map} A YAML mapping indicating the Perl modules this distribution recommends for enhanced operation. I<ALTERNATIVE: It may be desirable to present to the user which @@ -266,7 +264,7 @@ description: This feature is not available on this platform. excludes_os: MSWin32 -I<(Spec 1.1) [optional] A YAML sequence of names for optional features +I<(Spec 1.1) [optional] {map} A YAML sequence of names for optional features which are made available when its requirements are met. For each feature a description is provided along with any of L<"requires">, L<"build_requires">, L<"conflicts">, L<"requires_packages">, @@ -281,7 +279,7 @@ Data::Dumper: 0 File::Find: 1.03 -(Spec 1.0) [optional] A YAML mapping indicating the Perl modules +(Spec 1.0) [optional] {map} A YAML mapping indicating the Perl modules required for building and/or testing of this distribution. These dependencies are not required after the module is installed. @@ -293,7 +291,7 @@ Data::Dumper: 0 File::Find: 1.03 -(Spec 1.0) [optional] A YAML mapping indicating the Perl modules that +(Spec 1.0) [optional] {map} A YAML mapping indicating the Perl modules that cannot be installed while this distribution is installed. This is a pretty uncommon situation. @@ -303,7 +301,7 @@ dynamic_config: 0 -(Spec 1.0) [optional] A boolean flag indicating whether a F<Build.PL> +(Spec 1.0) [optional] {boolean} A boolean flag indicating whether a F<Build.PL> or F<Makefile.PL> (or similar) must be executed when building this distribution, or whether it can be built, tested and installed solely from consulting its @@ -320,7 +318,7 @@ =head2 private -I<(Deprecated)> (Spec 1.0) [optional] This field has been renamed to +I<(Deprecated)> (Spec 1.0) [optional] {map} This field has been renamed to L</"no_index">. See below. =head2 provides @@ -337,7 +335,7 @@ file: lib/Foo/Bar/Baz.pm version: 0.3 -(Spec 1.1) [optional] A YAML mapping that describes all packages +(Spec 1.1) [optional] {map} A YAML mapping that describes all packages provided by this distribution. This information can be (and, in some cases, is) used by distribution and automation mechanisms like PAUSE, CPAN, and search.cpan.org to build indexes saying in which @@ -367,7 +365,7 @@ namespace: - My::Module::Stuff -(Spec 1.1) [optional] A YAML mapping that describes any files, +(Spec 1.1) [optional] {map} A YAML mapping that describes any files, directories, packages, and namespaces that are private (i.e. implementation artifacts) that are not of interest to searching and indexing tools. This is useful when no C<provides> field is @@ -400,20 +398,29 @@ Example: keywords: - - make - - build - - install + - make + - build + - install -(Spec 1.1) [optional] A sequence of keywords/phrases that describe +(Spec 1.1) [optional] {list} A sequence of keywords/phrases that describe this distribution. =head2 resources -(Spec 1.1) [optional] A mapping of any URL resources related to this -distribution. All-lower-case keys, such as C<homepage>, C<license>, -and C<bugtracker>, are reserved by this specification, as they have -"official" meanings defined here in this specification. If you'd like -to add your own "special" entries, use at least one upper-case letter. +Example: + + resources: + license: http://dev.perl.org/licenses/ + homepage: http://sourceforge.net/projects/module-build + bugtracker: http://rt.cpan.org/NoAuth/Bugs.html?Dist=Module-Build + MailingList: http://lists.sourceforge.net/lists/listinfo/module-build-general + +(Spec 1.1) [optional] {map} A mapping of any URL resources related to +this distribution. All-lower-case keys, such as C<homepage>, +C<license>, and C<bugtracker>, are reserved by this specification, as +they have "official" meanings defined here in this specification. If +you'd like to add your own "special" entries (like the "MailingList" +entry above), use at least one upper-case letter. The current set of official keys is: @@ -440,7 +447,7 @@ generated_by: Module::Build version 0.20 -(Spec 1.0) [required] Indicates the tool that was used to create this +(Spec 1.0) [required] {string} Indicates the tool that was used to create this F<META.yml> file. It's good form to include both the name of the tool and its version, but this field is essentially opaque, at least for the moment. If F<META.yml> was generated by hand, it is suggested that |
