| 1 |
NAME |
| 2 |
CPAN::Meta::YAML - Read and write a subset of YAML for CPAN Meta files |
| 3 |
|
| 4 |
VERSION |
| 5 |
version 0.020 |
| 6 |
|
| 7 |
SYNOPSIS |
| 8 |
use CPAN::Meta::YAML; |
| 9 |
|
| 10 |
# reading a META file |
| 11 |
open $fh, "<:utf8", "META.yml"; |
| 12 |
$yaml_text = do { local $/; <$fh> }; |
| 13 |
$yaml = CPAN::Meta::YAML->read_string($yaml_text) |
| 14 |
or die CPAN::Meta::YAML->errstr; |
| 15 |
|
| 16 |
# finding the metadata |
| 17 |
$meta = $yaml->[0]; |
| 18 |
|
| 19 |
# writing a META file |
| 20 |
$yaml_text = $yaml->write_string |
| 21 |
or die CPAN::Meta::YAML->errstr; |
| 22 |
open $fh, ">:utf8", "META.yml"; |
| 23 |
print $fh $yaml_text; |
| 24 |
|
| 25 |
DESCRIPTION |
| 26 |
This module implements a subset of the YAML specification for use in |
| 27 |
reading and writing CPAN metadata files like META.yml and MYMETA.yml. It |
| 28 |
should not be used for any other general YAML parsing or generation |
| 29 |
task. |
| 30 |
|
| 31 |
NOTE: META.yml (and MYMETA.yml) files should be UTF-8 encoded. Users are |
| 32 |
responsible for proper encoding and decoding. In particular, the "read" |
| 33 |
and "write" methods do not support UTF-8 and should not be used. |
| 34 |
|
| 35 |
SUPPORT |
| 36 |
This module is currently derived from YAML::Tiny by Adam Kennedy. If |
| 37 |
there are bugs in how it parses a particular META.yml file, please file |
| 38 |
a bug report in the YAML::Tiny bugtracker: |
| 39 |
<https://github.com/Perl-Toolchain-Gang/YAML-Tiny/issues> |
| 40 |
|
| 41 |
SEE ALSO |
| 42 |
YAML::Tiny, YAML, YAML::XS |
| 43 |
|
| 44 |
AUTHORS |
| 45 |
* Adam Kennedy <[email protected]> |
| 46 |
|
| 47 |
* David Golden <[email protected]> |
| 48 |
|
| 49 |
CONTRIBUTOR |
| 50 |
Karen Etheridge <[email protected]> |
| 51 |
|
| 52 |
COPYRIGHT AND LICENSE |
| 53 |
This software is copyright (c) 2010 by Adam Kennedy. |
| 54 |
|
| 55 |
This is free software; you can redistribute it and/or modify it under |
| 56 |
the same terms as the Perl 5 programming language system itself. |
| 57 |
|