Debian Codegraph @

upstream/mageia-cauldron/man3pm/CPAN::Meta::History::Meta_1_1.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_1 3pm"
61 .TH CPAN::Meta::History::Meta_1_1 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_1 \- Version 1.1 metadata specification for META.yml
68 .SH PREFACE
69 .IX Header "PREFACE"
70 This is a historical copy of the version 1.1 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 Conversion from the original HTML to POD format
77 .IP \(bu 4
78 Include list of valid licenses from Module::Build 0.18 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 DESCRIPTION
84 .IX Header "DESCRIPTION"
85 This document describes version 1.1 of the \fIMETA.yml\fR specification.
86 .PP
87 The \fIMETA.yml\fR file describes important properties of contributed Perl
88 distributions such as the ones found on CPAN <http://www.cpan.org>. It is
89 typically created by tools like Module::Build and ExtUtils::MakeMaker.
90 .PP
91 The fields in the \fIMETA.yml\fR file are meant to be helpful to people
92 maintaining module collections (like CPAN), for people writing
93 installation tools (like CPAN or CPANPLUS), or just people who want to
94 know some stuff about a distribution before downloading it and starting to
95 install it.
96 .SH Format
97 .IX Header "Format"
98 \&\fIMETA.yml\fR files are written in the YAML <http://www.yaml.org/> format. The
99 reasons we chose YAML instead of, say, XML or Data::Dumper are discussed in
100 this thread <http://www.nntp.perl.org/group/perl.makemaker/2002/04/msg406.html>
101 on the MakeMaker mailing list.
102 .PP
103 The first line of a \fIMETA.yml\fR file should be a valid
104 YAML document header <http://yaml.org/spec/history/2002-10-31.html#syntax-document>
105 like \f(CW"\-\-\- #YAML:1.0"\fR
106 .SH Fields
107 .IX Header "Fields"
108 The rest of the META.yml file is one big YAML
109 mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping>,
110 whose keys are described here.
111 .IP name 4
112 .IX Item "name"
113 Example: \f(CW\*(C`Module\-Build\*(C'\fR
114 .Sp
115 The name of the distribution. Often created by taking the "main
116 module" in the distribution and changing "::" to "\-". Sometimes it\*(Aqs
117 completely different, however, as in the case of the
118 libwww\-perl <http://search.cpan.org/author/GAAS/libwww-perl/> distribution.
119 .IP version 4
120 .IX Item "version"
121 Example: \f(CW0.16\fR
122 .Sp
123 The version of the distribution to which the META.yml file refers.
124 This is a mandatory field.
125 .Sp
126 The version is essentially an arbitrary string, but \fImust\fR be
127 only ASCII characters, and \fIstrongly should\fR be of the format
128 integer\-dot\-digit\-digit, i.e. \f(CW25.57\fR, optionally followed by
129 underscore\-digit\-digit, i.e. \f(CW\*(C`25.57_04\*(C'\fR.
130 .Sp
131 The standard tools that deal with module distribution (PAUSE, CPAN,
132 etc.) form an identifier for each distribution by joining the \*(Aqname\*(Aq
133 and \*(Aqversion\*(Aq attributes with a dash (\f(CW\*(C`\-\*(C'\fR) character. Tools
134 who are prepared to deal with distributions that have no version
135 numbers generally omit the dash as well.
136 .IP license 4
137 .IX Item "license"
138 Example: \f(CW\*(C`perl\*(C'\fR
139 .Sp
140 a descriptive term for the licenses ... not authoritative, but must
141 be consistent with licensure statements in the READMEs, documentation, etc.
142 .Sp
143 The license under which this distribution may be used and
144 redistributed.
145 .Sp
146 Must be one of the following licenses:
147 .RS 4
148 .IP perl 4
149 .IX Item "perl"
150 The distribution may be copied and redistributed under the same terms as perl
151 itself (this is by far the most common licensing option for modules on CPAN).
152 This is a dual license, in which the user may choose between either the GPL
153 version 1 or the Artistic version 1 license.
154 .IP gpl 4
155 .IX Item "gpl"
156 The distribution is distributed under the terms of the GNU General Public
157 License version 2 (<http://opensource.org/licenses/GPL\-2.0>).
158 .IP lgpl 4
159 .IX Item "lgpl"
160 The distribution is distributed under the terms of the GNU Lesser General
161 Public License version 2 (<http://opensource.org/licenses/LGPL\-2.1>).
162 .IP artistic 4
163 .IX Item "artistic"
164 The distribution is licensed under the Artistic License version 1, as specified
165 by the Artistic file in the standard perl distribution
166 (<http://opensource.org/licenses/Artistic\-Perl\-1.0>).
167 .IP bsd 4
168 .IX Item "bsd"
169 The distribution is licensed under the BSD 3\-Clause License
170 (<http://opensource.org/licenses/BSD\-3\-Clause>).
171 .IP open_source 4
172 .IX Item "open_source"
173 The distribution is licensed under some other Open Source Initiative\-approved
174 license listed at <http://www.opensource.org/licenses/>.
175 .IP unrestricted 4
176 .IX Item "unrestricted"
177 The distribution is licensed under a license that is \fBnot\fR approved by
178 www.opensource.org <http://www.opensource.org/> but that allows distribution
179 without restrictions.
180 .IP restrictive 4
181 .IX Item "restrictive"
182 The distribution may not be redistributed without special permission from the
183 author and/or copyright holder.
184 .RE
185 .RS 4
186 .RE
187 .IP license_uri 4
188 .IX Item "license_uri"
189 This should contain a URI where the exact terms of the license may be found.
190 .Sp
191 (change "unrestricted" to "redistributable"?)
192 .IP distribution_type 4
193 .IX Item "distribution_type"
194 Example: \f(CW\*(C`module\*(C'\fR
195 .Sp
196 What kind of stuff is contained in this distribution. Most things on
197 CPAN are \f(CW\*(C`module\*(C'\fRs (which can also mean a collection of
198 modules), but some things are \f(CW\*(C`script\*(C'\fRs.
199 .Sp
200 This field is basically meaningless, and tools (like Module::Build or
201 MakeMaker) will likely stop generating it in the future.
202 .IP private 4
203 .IX Item "private"
204 WTF is going on here?
205 .Sp
206 index_ignore: any application that indexes the contents of
207 distributions (PAUSE, search.cpan.org) ought to ignore the items
208 (packages, files, directories, namespace hierarchies).
209 .IP requires 4
210 .IX Item "requires"
211 Example:
212 .Sp
213 .Vb 2
214 \& Data::Dumper: 0
215 \& File::Find: 1.03
216 .Ve
217 .Sp
218 A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping>
219 indicating the Perl modules this distribution requires for proper
220 operation. The keys are the module names, and the values are version
221 specifications as described in the
222 documentation for Module::Build\*(Aqs "requires" parameter.
223 .Sp
224 \&\fINote: the exact nature of the fancy specifications like
225 \&\fR\f(CI">= 1.2, != 1.5, < 2.0"\fR\fI is subject to
226 change. Advance notice will be given here. The simple specifications
227 like \fR\f(CI"1.2"\fR\fI will not change in format.\fR
228 .IP recommends 4
229 .IX Item "recommends"
230 Example:
231 .Sp
232 .Vb 2
233 \& Data::Dumper: 0
234 \& File::Find: 1.03
235 .Ve
236 .Sp
237 A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping>
238 indicating the Perl modules this distribution recommends for enhanced
239 operation.
240 .IP build_requires 4
241 .IX Item "build_requires"
242 Example:
243 .Sp
244 .Vb 2
245 \& Data::Dumper: 0
246 \& File::Find: 1.03
247 .Ve
248 .Sp
249 A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping>
250 indicating the Perl modules required for building and/or testing of
251 this distribution. These dependencies are not required after the
252 module is installed.
253 .IP conflicts 4
254 .IX Item "conflicts"
255 Example:
256 .Sp
257 .Vb 2
258 \& Data::Dumper: 0
259 \& File::Find: 1.03
260 .Ve
261 .Sp
262 A YAML mapping <http://yaml.org/spec/history/2002-10-31.html#syntax-mapping>
263 indicating the Perl modules that cannot be installed while this
264 distribution is installed. This is a pretty uncommon situation.
265 .Sp
266 \&\- possibly separate out test\-time prereqs, complications include: can
267 tests be meaningfully preserved for later running? are test\-time
268 prereqs in addition to build\-time, or exclusive?
269 .Sp
270 \&\- make official location for installed *distributions*, which can
271 contain tests, etc.
272 .IP dynamic_config 4
273 .IX Item "dynamic_config"
274 Example: \f(CW0\fR
275 .Sp
276 A boolean flag indicating whether a \fIBuild.PL\fR or
277 \&\fIMakefile.PL\fR (or similar) must be executed, or whether this
278 module can be built, tested and installed solely from consulting its
279 metadata file. The main reason to set this to a true value if that
280 your module performs some dynamic configuration (asking questions,
281 sensing the environment, etc.) as part of its build/install process.
282 .Sp
283 Currently Module::Build doesn\*(Aqt actually do anything with
284 this flag \- it\*(Aqs probably going to be up to higher\-level tools like
285 CPAN.pm to do something useful with it. It can potentially
286 bring lots of security, packaging, and convenience improvements.
287 .IP generated_by 4
288 .IX Item "generated_by"
289 Example: \f(CW\*(C`Module::Build version 0.16\*(C'\fR
290 .Sp
291 Indicates the tool that was used to create this \fIMETA.yml\fR file. It\*(Aqs
292 good form to include both the name of the tool and its version, but
293 this field is essentially opaque, at least for the moment.
294 .SS "Ingy\*(Aqs suggestions"
295 .IX Subsection "Ingy's suggestions"
296 .IP short_description 4
297 .IX Item "short_description"
298 add as field, containing abstract, maximum 80 characters, suggested minimum 40 characters
299 .IP description 4
300 .IX Item "description"
301 long version of abstract, should add?
302 .IP maturity 4
303 .IX Item "maturity"
304 alpha, beta, gamma, mature, stable
305 .IP "author_id, owner_id" 4
306 .IX Item "author_id, owner_id"
307 .PD 0
308 .IP "categorization, keyword, chapter_id" 4
309 .IX Item "categorization, keyword, chapter_id"
310 .IP "URL for further information" 4
311 .IX Item "URL for further information"
312 .PD
313 could default to search.cpan.org on PAUSE
314 .IP namespaces 4
315 .IX Item "namespaces"
316 can be specified for single elements by prepending
317 dotted\-form, i.e. "com.example.my_application.my_property". Default
318 namespace for META.yml is probably "org.cpan.meta_author" or
319 something. Precedent for this is Apple\*(Aqs Carbon namespaces, I think.
320 .SH History
321 .IX Header "History"
322 .IP \(bu 4
323 \&\fBMarch 14, 2003\fR (Pi day) \- created version 1.0 of this document.
324 .IP \(bu 4
325 \&\fBMay 8, 2003\fR \- added the "dynamic_config" field, which was missing from the
326 initial version.