diff options
| author | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2017-06-03 14:19:53 +0300 |
|---|---|---|
| committer | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2017-06-03 14:19:53 +0300 |
| commit | e91b1cdae38d693fbd34a57341d8c72737f0ec22 (patch) | |
| tree | 319e5d53b9f054b285ad0d6a9636c271578a676e /docs | |
| parent | 1ce44f30467e4882580ca8545f15ba7d882cb428 (diff) | |
| download | micropython-e91b1cdae38d693fbd34a57341d8c72737f0ec22.tar.gz micropython-e91b1cdae38d693fbd34a57341d8c72737f0ec22.zip | |
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.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/library/uos.rst | 26 | ||||
| -rw-r--r-- | docs/wipy/general.rst | 23 |
2 files changed, 27 insertions, 22 deletions
diff --git a/docs/library/uos.rst b/docs/library/uos.rst index 82ed5dbc93..3d0aa46c70 100644 --- a/docs/library/uos.rst +++ b/docs/library/uos.rst @@ -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. diff --git a/docs/wipy/general.rst b/docs/wipy/general.rst index 1e396518e0..f28edb4e4b 100644 --- a/docs/wipy/general.rst +++ b/docs/wipy/general.rst @@ -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. + |