summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authornobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-09-21 04:42:21 +0000
committernobu <nobu@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-09-21 04:42:21 +0000
commit7fff518d533b5a9aca3be62bf5af7c85ef1ca485 (patch)
treec4e8cc51aad6d29713a9e8a7965640e607901593
parent28e50d05d3c8a15bf55604fff865295072916e30 (diff)
io.c: [DOC]
* io.c (rb_io_advise): [DOC] adjust indent and fix lists. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@43005 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
-rw-r--r--io.c45
1 files changed, 23 insertions, 22 deletions
diff --git a/io.c b/io.c
index b6c67c4..2af7edd 100644
--- a/io.c
+++ b/io.c
@@ -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)