From 8670d553685433ebfaefa2e19a19e41114a4e5bb Mon Sep 17 00:00:00 2001
From: drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Thu, 30 Jun 2011 00:30:46 +0000
Subject: 	* lib/yaml.rb:  Document toplevel YAML and YAML::ENGINE to
 describe 	  Psych vs Syck engines.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@32313 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 lib/yaml.rb | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'lib')

diff --git a/lib/yaml.rb b/lib/yaml.rb
index eb0427a9d4..ff9e1a6344 100644
--- a/lib/yaml.rb
+++ b/lib/yaml.rb
@@ -1,3 +1,18 @@
+##
+# The YAML module allows you to use one of the two YAML engines that ship with
+# ruby.  By default Psych is used but the old and unmaintained Syck may be
+# chosen.
+#
+# See Psych or Syck for usage and documentation.
+#
+# To set the YAML engine to syck:
+#
+#   YAML::ENGINE.yamler = 'syck'
+#
+# To set the YAML engine back to psych:
+#
+#   YAML::ENGINE.yamler = 'psych'
+
 module YAML
   class EngineManager # :nodoc:
     attr_reader :yamler
@@ -27,6 +42,9 @@ module YAML
     end
   end
 
+  ##
+  # Allows changing the current YAML engine.  See YAML for details.
+
   ENGINE = YAML::EngineManager.new
 end
 
-- 
cgit v1.2.3