Permalink
Browse files

Include a WARNING section in YAML::Syck pod

  • Loading branch information...
1 parent 37de08d commit 56dd37597921dcc7ae19cc031ff50afea6529b35 @avar committed May 23, 2010
Showing with 40 additions and 0 deletions.
  1. +4 −0 Changes
  2. +17 −0 README
  3. +19 −0 lib/YAML/Syck.pm
View
@@ -5,6 +5,10 @@ improvements.
* POD link to JSON::XS from JSON::Syck
+* Include a WARNING section in the YAML::Syck pod that mentions that
+ the module hasn't been actively maintained since 2007, and that
+ perhaps prospective users might want to turn elsewhere.
+
[Changes for 1.07_01 (JSON::Syck 0.30) - 2010-05-20]
About:
View
17 README
@@ -19,6 +19,23 @@ SYNOPSIS
$yaml = Dump(@data);
@data = Load($yaml);
+WARNING
+ This module has a lot of known issues
+ <https://rt.cpan.org/Public/Dist/Display.html?Name=YAML-Syck> and hasn't
+ been actively maintained since 2007. If you encounter an issue with it
+ probably won't be fixed unless you offer up a patch
+ <http://github.com/avar/YAML-Syck> in Git that's ready for release.
+
+ Consider using YAML::XS instead, or not using YAML at all. YAML is
+ falling out of style in the Perl community in favor of simpler formats
+ like JSON, which don't suffer from the bugs and annoying
+ incompatibilities that plague the ambitious YAML format.
+
+ There are still some good reasons to use this module, such as better
+ interoperability with other syck wrappers (like Ruby's), or some edge
+ case of YAML's syntax that it handles better. Maybe it'll work perfectly
+ for you, but if it doesn't you may be in for some pain.
+
DESCRIPTION
This module provides a Perl interface to the libsyck data serialization
library. It exports the "Dump" and "Load" functions for converting Perl
View
@@ -156,6 +156,25 @@ YAML::Syck - Fast, lightweight YAML loader and dumper
$yaml = Dump(@data);
@data = Load($yaml);
+=head1 WARNING
+
+This module has L<a lot of known
+issues|https://rt.cpan.org/Public/Dist/Display.html?Name=YAML-Syck>
+and hasn't been actively maintained since 2007. If you encounter an
+issue with it probably won't be fixed unless you L<offer up a
+patch|http://github.com/avar/YAML-Syck> in Git that's ready for
+release.
+
+Consider using L<YAML::XS> instead, or not using YAML at all. YAML is
+falling out of style in the Perl community in favor of simpler formats
+like JSON, which don't suffer from the bugs and annoying
+incompatibilities that plague the ambitious YAML format.
+
+There are still some good reasons to use this module, such as better
+interoperability with other syck wrappers (like Ruby's), or some edge
+case of YAML's syntax that it handles better. Maybe it'll work
+perfectly for you, but if it doesn't you may be in for some pain.
+
=head1 DESCRIPTION
This module provides a Perl interface to the B<libsyck> data serialization

0 comments on commit 56dd375

Please sign in to comment.