summaryrefslogtreecommitdiffstatshomepage
path: root/docs/wipy/general.rst
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2017-06-03 14:19:53 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2017-06-03 14:19:53 +0300
commite91b1cdae38d693fbd34a57341d8c72737f0ec22 (patch)
tree319e5d53b9f054b285ad0d6a9636c271578a676e /docs/wipy/general.rst
parent1ce44f30467e4882580ca8545f15ba7d882cb428 (diff)
downloadmicropython-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/wipy/general.rst')
-rw-r--r--docs/wipy/general.rst23
1 files changed, 23 insertions, 0 deletions
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.
+