Fixes for grammar and style [ci skip]

* io.c (rb_f_select): [DOC] Fixes for grammar and style.
  [Fix GH-906]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@50572 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
nobu 2015-05-21 01:51:51 +00:00
Родитель 4b0987a629
Коммит cac2c6d331
2 изменённых файлов: 20 добавлений и 15 удалений

Просмотреть файл

@ -1,3 +1,8 @@
Thu May 21 10:51:54 2015 Jake Worth <jakeworth82@gmail.com>
* io.c (rb_f_select): [DOC] Fixes for grammar and style.
[Fix GH-906]
Thu May 21 08:25:19 2015 Eric Wong <e@80x24.org> Thu May 21 08:25:19 2015 Eric Wong <e@80x24.org>
* variable.c (Init_var_tables): init generic_iv_tbl * variable.c (Init_var_tables): init generic_iv_tbl

30
io.c
Просмотреть файл

@ -8688,8 +8688,8 @@ rb_io_advise(int argc, VALUE *argv, VALUE io)
* IO.select(read_array [, write_array [, error_array [, timeout]]]) -> array or nil * IO.select(read_array [, write_array [, error_array [, timeout]]]) -> array or nil
* *
* Calls select(2) system call. * Calls select(2) system call.
* It monitors given arrays of <code>IO</code> objects, waits one or more * It monitors given arrays of <code>IO</code> objects, waits until one or more
* of <code>IO</code> objects ready for reading, are ready for writing, * of <code>IO</code> objects are ready for reading, are ready for writing,
* and have pending exceptions respectively, and returns an array that * and have pending exceptions respectively, and returns an array that
* contains arrays of those IO objects. It will return <code>nil</code> * contains arrays of those IO objects. It will return <code>nil</code>
* if optional <i>timeout</i> value is given and no <code>IO</code> object * if optional <i>timeout</i> value is given and no <code>IO</code> object
@ -8697,13 +8697,13 @@ rb_io_advise(int argc, VALUE *argv, VALUE io)
* *
* <code>IO.select</code> peeks the buffer of <code>IO</code> objects for testing readability. * <code>IO.select</code> peeks the buffer of <code>IO</code> objects for testing readability.
* If the <code>IO</code> buffer is not empty, * If the <code>IO</code> buffer is not empty,
* <code>IO.select</code> immediately notify readability. * <code>IO.select</code> immediately notifies readability.
* This "peek" is only happen for <code>IO</code> objects. * This "peek" only happens for <code>IO</code> objects.
* It is not happen for IO-like objects such as OpenSSL::SSL::SSLSocket. * It does not happen for IO-like objects such as OpenSSL::SSL::SSLSocket.
* *
* The best way to use <code>IO.select</code> is invoking it * The best way to use <code>IO.select</code> is invoking it
* after nonblocking methods such as <code>read_nonblock</code>, <code>write_nonblock</code>, etc. * after nonblocking methods such as <code>read_nonblock</code>, <code>write_nonblock</code>, etc.
* The methods raises an exception which is extended by * The methods raise an exception which is extended by
* <code>IO::WaitReadable</code> or <code>IO::WaitWritable</code>. * <code>IO::WaitReadable</code> or <code>IO::WaitWritable</code>.
* The modules notify how the caller should wait with <code>IO.select</code>. * The modules notify how the caller should wait with <code>IO.select</code>.
* If <code>IO::WaitReadable</code> is raised, the caller should wait for reading. * If <code>IO::WaitReadable</code> is raised, the caller should wait for reading.
@ -8731,37 +8731,37 @@ rb_io_advise(int argc, VALUE *argv, VALUE io)
* This means that readability notified by <code>IO.select</code> doesn't mean * This means that readability notified by <code>IO.select</code> doesn't mean
* readability from <code>OpenSSL::SSL::SSLSocket</code> object. * readability from <code>OpenSSL::SSL::SSLSocket</code> object.
* *
* Most possible situation is <code>OpenSSL::SSL::SSLSocket</code> buffers some data. * The most likely situation is that <code>OpenSSL::SSL::SSLSocket</code> buffers some data.
* <code>IO.select</code> doesn't see the buffer. * <code>IO.select</code> doesn't see the buffer.
* So <code>IO.select</code> can block when <code>OpenSSL::SSL::SSLSocket#readpartial</code> doesn't block. * So <code>IO.select</code> can block when <code>OpenSSL::SSL::SSLSocket#readpartial</code> doesn't block.
* *
* However several more complicated situation exists. * However, several more complicated situations exist.
* *
* SSL is a protocol which is sequence of records. * SSL is a protocol which is sequence of records.
* The record consists multiple bytes. * The record consists of multiple bytes.
* So, the remote side of SSL sends a partial record, * So, the remote side of SSL sends a partial record,
* <code>IO.select</code> notifies readability but * <code>IO.select</code> notifies readability but
* <code>OpenSSL::SSL::SSLSocket</code> cannot decrypt a byte and * <code>OpenSSL::SSL::SSLSocket</code> cannot decrypt a byte and
* <code>OpenSSL::SSL::SSLSocket#readpartial</code> will blocks. * <code>OpenSSL::SSL::SSLSocket#readpartial</code> will blocks.
* *
* Also, the remote side can request SSL renegotiation which forces * Also, the remote side can request SSL renegotiation which forces
* the local SSL engine writes some data. * the local SSL engine to write some data.
* This means <code>OpenSSL::SSL::SSLSocket#readpartial</code> may * This means <code>OpenSSL::SSL::SSLSocket#readpartial</code> may
* invoke <code>write</code> system call and it can block. * invoke <code>write</code> system call and it can block.
* In such situation, <code>OpenSSL::SSL::SSLSocket#read_nonblock</code> * In such a situation, <code>OpenSSL::SSL::SSLSocket#read_nonblock</code>
* raises IO::WaitWritable instead of blocking. * raises IO::WaitWritable instead of blocking.
* So, the caller should wait for ready for writability as above example. * So, the caller should wait for ready for writability as above example.
* *
* The combination of nonblocking methods and <code>IO.select</code> is * The combination of nonblocking methods and <code>IO.select</code> is
* also useful for streams such as tty, pipe socket socket when * also useful for streams such as tty, pipe socket socket when
* multiple process read form a stream. * multiple processes read from a stream.
* *
* Finally, Linux kernel developers doesn't guarantee that * Finally, Linux kernel developers don't guarantee that
* readability of select(2) means readability of following read(2) even * readability of select(2) means readability of following read(2) even
* for single process. * for a single process.
* See select(2) manual on GNU/Linux system. * See select(2) manual on GNU/Linux system.
* *
* Invoking <code>IO.select</code> before <code>IO#readpartial</code> works well in usual. * Invoking <code>IO.select</code> before <code>IO#readpartial</code> works well as usual.
* However it is not the best way to use <code>IO.select</code>. * However it is not the best way to use <code>IO.select</code>.
* *
* The writability notified by select(2) doesn't show * The writability notified by select(2) doesn't show