Merge pull request symfony#2623 from jbafford/i2570-22

weaverryan · weaverryan · commit afce899c8679 · 2013-05-10T12:03:37.000-07:00
Update yaml component docs to reflect Yaml::parse(filename) deprecation
diff --git a/components/yaml/introduction.rst b/components/yaml/introduction.rst
@@ -120,20 +120,26 @@ error occurred:
     As the parser is re-entrant, you can use the same parser object to load
     different YAML strings.
 
-When loading a YAML file, it is sometimes better to use the
+It may also be convenient to use the
 :method:`Symfony\\Component\\Yaml\\Yaml::parse` wrapper method:
 
 .. code-block:: php
 
     use Symfony\Component\Yaml\Yaml;
 
-    $yaml = Yaml::parse('/path/to/file.yml');
+    $yaml = Yaml::parse(file_get_contents('/path/to/file.yml'));
 
 The :method:`Symfony\\Component\\Yaml\\Yaml::parse` static method takes a YAML
 string or a file containing YAML. Internally, it calls the
 :method:`Symfony\\Component\\Yaml\\Parser::parse` method, but enhances the
 error if something goes wrong by adding the filename to the message.
 
+.. caution::
+
+    Because it is currently possible to pass a filename to this method, you
+    must validate the input first. Passing a filename is deprecated in
+    Symfony 2.2, and will be removed in Symfony 3.0.
+
 Executing PHP Inside YAML Files
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
