aboutsummaryrefslogtreecommitdiffstats
path: root/io.c
diff options
context:
space:
mode:
authorakr <akr@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2017-10-21 06:45:41 +0000
committerakr <akr@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2017-10-21 06:45:41 +0000
commitb10f2d5a0975c1945492db337458bcca09dd6405 (patch)
treef0c29048f07dfd4de3dad4166edba6b94f386ee2 /io.c
parent2cd5fca17d08c4a3b3e2fc8a31643ff2bf9ef618 (diff)
downloadruby-b10f2d5a0975c1945492db337458bcca09dd6405.tar.gz
[DOC] describe methods used for src and dst argument.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@60233 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'io.c')
-rw-r--r--io.c7
1 files changed, 6 insertions, 1 deletions
diff --git a/io.c b/io.c
index e4c7763572..491442bd28 100644
--- a/io.c
+++ b/io.c
@@ -11017,7 +11017,12 @@ copy_stream_finalize(VALUE arg)
* IO.copy_stream(src, dst, copy_length, src_offset)
*
* IO.copy_stream copies <i>src</i> to <i>dst</i>.
- * <i>src</i> and <i>dst</i> is either a filename or an IO.
+ * <i>src</i> and <i>dst</i> is either a filename or an IO-like object.
+ * IO-like object for <i>src</i> should have <code>readpartial</code> or
+ * <code>read</code> method.
+ * IO-like object for <i>dst</i> should have <code>write</code> method.
+ * (Specialized mechanisms, such as sendfile system call, may be used
+ * on appropriate situation.)
*
* This method returns the number of bytes copied.
*