diff options
| author | danicampora <daniel@wipy.io> | 2015-10-14 12:32:01 +0200 |
|---|---|---|
| committer | danicampora <daniel@wipy.io> | 2015-10-17 23:29:04 +0200 |
| commit | 4542643025c77a7272bde348b89d5039aea28d23 (patch) | |
| tree | bf9fb006f46b96d2ea9ecf4aa190c4e4cc2abfc8 /docs/library/os.rst | |
| parent | fca3308cc376f2c1c66fa3cef82e30c55c9acca2 (diff) | |
docs: Update all WiPy docs to reflect the new API.
Diffstat (limited to 'docs/library/os.rst')
| -rw-r--r-- | docs/library/os.rst | 24 |
1 files changed, 21 insertions, 3 deletions
diff --git a/docs/library/os.rst b/docs/library/os.rst index e32a409f5..302d71fd5 100644 --- a/docs/library/os.rst +++ b/docs/library/os.rst @@ -71,9 +71,27 @@ Functions .. only:: port_wipy - .. function:: mkfs(drive) - - Formats the specified drive, must be either ``/flash`` or ``/sd``. + .. 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 prevoulsy 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. Constants --------- |