Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs to recommend YAML::PP #227

Closed
wants to merge 3 commits into from
Closed

Update docs to recommend YAML::PP #227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1e80dbf
Update docs to recommend YAML::PP
ingydotnet Dec 27, 2023
d8ea6dd
Add "See Also" section recommending YAML::PP
ingydotnet Dec 27, 2023
ddc7867
Remove "see also" from Meta
ingydotnet Dec 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions Meta
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,3 @@ test:
Test::More: 0.88
Test::Deep: 0
Encode: 0

see: YAML::XS
45 changes: 29 additions & 16 deletions doc/YAML.swim
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,30 @@
<<<cpan-head>>>

= Note

This module has been released to CPAN as [YAML::Old], and soon YAML.pm will be
changed to just be a frontend interface module for all the various Perl YAML
implementation modules, including YAML::Old.
= IMPORTANT - Please Read This First

If you want robust and fast YAML processing using the normal Dump/Load API,
please consider switching to [YAML::XS]. It is by far the best Perl module for
YAML at this time. It requires that you have a C compiler, since it is written
in C.
If you need to use YAML with Perl, it is likely that you will have a look at
this module (`YAML.pm`) first.
There are several "YAML modules"[https://metacpan.org/search?q=yaml] in Perl
and they all support the simple `Load()` and `Dump()` API.
Since this one has the obvious name "YAML", it may seem obvious to pick this
one.

If you really need to use this version of YAML.pm it will always be available
as YAML::Old.
As the author of this module, I humbly ask you to choose another.
YAML.pm was the very first YAML implementation in the world, released in 2001.
It was originally made as a prototype, over 2 years before the YAML 1.0 spec
was published.
Although it may work for your needs, it has numerous bugs and is barely
maintained.

Please consider using these first:

* [YAML::PP] - Pure Perl, Full Featured, Well Maintained
* [YAML::PP::LibYAML] - A `libyaml` Perl binding like [YAML::XS] but with the
YAML::PP API.

The rest of this documentation is left unchanged...

The rest of this documentation is left unchanged, until YAML.pm is switched
over to the new UI-only version.

= Synopsis

Expand Down Expand Up @@ -673,13 +682,17 @@ YAML.pm is still fairly useful. Things will get much better in the future.

= Resources

[http://lists.sourceforge.net/lists/listinfo/yaml-core] is the mailing list.
This is where the language is discussed and designed.

[http://www.yaml.org] is the official YAML website.

[http://www.yaml.org/spec/] is the YAML 1.2 specification.

[http://yaml.kwiki.org] is the official YAML wiki.

= See Also

* [YAML::PP] - This is almost certainly the YAML module you are looking for.
It is full-featured and well maintained.

* [YAML::PP::LibYAML] - Same overall API as YAML::PP but uses the libyaml
shared library for speed.

<<<cpan-tail +see>>>