docs/uos: Move cc3200 port legacy VFS mounting functions to its ref doc.

This patch also unconditionalizes uos.dupterm(), though exact interface
and semantics is yet to be defined.
This commit is contained in:
Paul Sokolovsky 2017-06-03 14:19:53 +03:00
parent 1ce44f3046
commit e91b1cdae3
2 changed files with 27 additions and 22 deletions

View File

@ -87,26 +87,8 @@ Functions
Return a bytes object with n random bytes. Whenever possible, it is
generated by the hardware random number generator.
.. only:: port_wipy
.. function:: dupterm(stream_object)
.. function:: mount(block_device, mount_point, \*, readonly=False)
Mounts a block device (like an ``SD`` object) in the specified mount
point. Example::
os.mount(sd, '/sd')
.. function:: unmount(path)
Unmounts a previously mounted block device from the given path.
.. function:: mkfs(block_device or path)
Formats the specified path, must be either ``/flash`` or ``/sd``.
A block device can also be passed like an ``SD`` object before
being mounted.
.. function:: dupterm(stream_object)
Duplicate the terminal (the REPL) on the passed stream-like object.
The given object must at least implement the ``.read()`` and ``.write()`` methods.
Duplicate or switch MicroPython terminal (the REPL) on the passed stream-like
object. The given object must implement the `.readinto()` and `.write()`
methods. If ``None`` is passed, previously set redirection is cancelled.

View File

@ -360,3 +360,26 @@ Example::
Returns ``True`` if the server is running, ``False`` otherwise.
Adhoc VFS-like support
~~~~~~~~~~~~~~~~~~~~~~
WiPy doesn't implement full MicroPython VFS support, instead following
functions are defined in ``uos`` module:
.. function:: mount(block_device, mount_point, \*, readonly=False)
Mounts a block device (like an ``SD`` object) in the specified mount
point. Example::
os.mount(sd, '/sd')
.. function:: unmount(path)
Unmounts a previously mounted block device from the given path.
.. function:: mkfs(block_device or path)
Formats the specified path, must be either ``/flash`` or ``/sd``.
A block device can also be passed like an ``SD`` object before
being mounted.