diff options
author | Damien George <damien.p.george@gmail.com> | 2018-06-28 13:25:10 +1000 |
---|---|---|
committer | Damien George <damien.p.george@gmail.com> | 2018-06-28 13:25:10 +1000 |
commit | ab02abe96dc2ccdb2556c894dc04de11674e3476 (patch) | |
tree | bb61b56a063914df7b1baf998bdbabf56453098d | |
parent | d800ed187756c734458d269b1bf0dbfe554ad4f1 (diff) |
docs/uos: Make it clear that block device block_num param is an index.
-rw-r--r-- | docs/library/uos.rst | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/library/uos.rst b/docs/library/uos.rst index 27f339bb1..c073f079d 100644 --- a/docs/library/uos.rst +++ b/docs/library/uos.rst @@ -193,14 +193,16 @@ used by a particular filesystem driver to store the data for its filesystem. .. method:: readblocks(block_num, buf) - Starting at *block_num*, read blocks from the device into *buf* (an array - of bytes). The number of blocks to read is given by the length of *buf*, + Starting at the block given by the index *block_num*, read blocks from + the device into *buf* (an array of bytes). + The number of blocks to read is given by the length of *buf*, which will be a multiple of the block size. .. method:: writeblocks(block_num, buf) - Starting at *block_num*, write blocks from *buf* (an array of bytes) to - the device. The number of blocks to write is given by the length of *buf*, + Starting at the block given by the index *block_num*, write blocks from + *buf* (an array of bytes) to the device. + The number of blocks to write is given by the length of *buf*, which will be a multiple of the block size. .. method:: ioctl(op, arg) |