* io.c (rb_io_s_read): add description of pipes to the documentation

  of IO.read.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@55610 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

2 files changed, 8 insertions, 0 deletions

diff --git a/ChangeLog b/ChangeLog
index 950d11daf0..d3708e0be0 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+Fri Jul  8 08:43:31 2016  Shugo Maeda  <shugo@ruby-lang.org>
+
+	* io.c (rb_io_s_read): add description of pipes to the documentation
+	  of IO.read.
+
 Fri Jul  8 03:54:22 2016  NARUSE, Yui  <naruse@ruby-lang.org>
 
 	* vm_args.c (setup_parameters_complex): don't raise ArgumentError
diff --git a/io.c b/io.c
index 2f09957470..19a0c9d426 100644
--- a/io.c
+++ b/io.c
@@ -9848,6 +9848,9 @@ seek_before_access(VALUE argp)
  *  +length+ bytes (defaulting to the rest of the file).  <code>read</code>
  *  ensures the file is closed before returning.
  *
+ *  If +name+ starts with a pipe character (<code>"|"</code>), a subprocess is
+ *  created in the same way as Kernel#open, and its output is returned.
+ *
  *  === Options
  *
  *  The options hash accepts the following keys: