io.c: [DOC] about buffering [ci skip]

* io.c (rb_file_initialize): [DOC] stated that non-tty file is
  buffered by the default, and added links to related methods.
  [ruby-core:83081] [Bug #13965]

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

1 files changed, 5 insertions, 0 deletions

diff --git a/io.c b/io.c
index 6226108ad6..3000e94d9a 100644
--- a/io.c
+++ b/io.c
@@ -7952,6 +7952,11 @@ rb_io_initialize(int argc, VALUE *argv, VALUE io)
  *  mode and permission bits are platform dependent; on Unix systems, see
  *  open(2) and chmod(2) man pages for details.
  *
+ *  The new File object is buffered mode (or non-sync mode), unless
+ *  +filename+ is a tty.
+ *  See IO#flush, IO#fsync, IO#fdatasync, and <code>IO#sync=</code>
+ *  about sync mode.
+ *
  *  === Examples
  *
  *    f = File.new("testfile", "r")