diff options
-rw-r--r-- | io.c | 45 |
1 files changed, 23 insertions, 22 deletions
@@ -8413,18 +8413,18 @@ advice_arg_check(VALUE advice) * specific pattern. On platforms that do not support the * <em>posix_fadvise(2)</em> system call, this method is a no-op. * - * _advice_ is one of the following symbols: + * _advice_ is one of the following symbols: * - * * :normal - No advice to give; the default assumption for an open file. - * * :sequential - The data will be accessed sequentially: - * with lower offsets read before higher ones. - * * :random - The data will be accessed in random order. - * * :willneed - The data will be accessed in the near future. - * * :dontneed - The data will not be accessed in the near future. - * * :noreuse - The data will only be accessed once. + * :normal:: No advice to give; the default assumption for an open file. + * :sequential:: The data will be accessed sequentially + * with lower offsets read before higher ones. + * :random:: The data will be accessed in random order. + * :willneed:: The data will be accessed in the near future. + * :dontneed:: The data will not be accessed in the near future. + * :noreuse:: The data will only be accessed once. * - * The semantics of a piece of advice are platform-dependent. See - * <em>man 2 posix_fadvise</em> for details. + * The semantics of a piece of advice are platform-dependent. See + * <em>man 2 posix_fadvise</em> for details. * * "data" means the region of the current file that begins at * _offset_ and extends for _len_ bytes. If _len_ is 0, the region @@ -8433,18 +8433,19 @@ advice_arg_check(VALUE advice) * * If an error occurs, one of the following exceptions will be raised: * - * * <code>IOError</code> - The <code>IO</code> stream is closed. - * * <code>Errno::EBADF</code> - The file descriptor of the current file is - invalid. - * * <code>Errno::EINVAL</code> - An invalid value for _advice_ was given. - * * <code>Errno::ESPIPE</code> - The file descriptor of the current - * * file refers to a FIFO or pipe. (Linux raises <code>Errno::EINVAL</code> - * * in this case). - * * <code>TypeError</code> - Either _advice_ was not a Symbol, or one of the - other arguments was not an <code>Integer</code>. - * * <code>RangeError</code> - One of the arguments given was too big/small. - * - * This list is not exhaustive; other Errno:: exceptions are also possible. + * <code>IOError</code>:: The <code>IO</code> stream is closed. + * <code>Errno::EBADF</code>:: + * The file descriptor of the current file is invalid. + * <code>Errno::EINVAL</code>:: An invalid value for _advice_ was given. + * <code>Errno::ESPIPE</code>:: + * The file descriptor of the current file refers to a FIFO or + * pipe. (Linux raises <code>Errno::EINVAL</code> in this case). + * <code>TypeError</code>:: + * Either _advice_ was not a Symbol, or one of the + * other arguments was not an <code>Integer</code>. + * <code>RangeError</code>:: One of the arguments given was too big/small. + * + * This list is not exhaustive; other Errno:: exceptions are also possible. */ static VALUE rb_io_advise(int argc, VALUE *argv, VALUE io) |