Lephenixnoir
/
PythonExtra
1
0
Fork 2
Code Issues 9 Pull Requests 3 Projects Releases 2 Wiki Activity

docs/library/pyb: Add deprecation warning for mount and old block proto. 

pyb.mount(None, mountpoint) functionality is also removed and replaced by
uos.umount.
This commit is contained in:
Peter Hinch 2018-09-16 11:56:57 +01:00 committed by Damien George
parent 1628cd0e59
commit 927a5d1dfd
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/library/pyb.rst
View File

@ -212,8 +212,13 @@ Miscellaneous functions
.. function:: mount(device, mountpoint, \*, readonly=False, mkfs=False)
.. note:: This function is deprecated. Mounting and unmounting devices should
be performed by :meth:`uos.mount` and :meth:`uos.umount` instead.
Mount a block device and make it available as part of the filesystem.
``device`` must be an object that provides the block protocol:
``device`` must be an object that provides the block protocol. (The
following is also deprecated. See :class:`uos.AbstractBlockDev` for the
correct way to create a block device.)
- ``readblocks(self, blocknum, buf)``
- ``writeblocks(self, blocknum, buf)`` (optional)
@ -238,9 +243,6 @@ Miscellaneous functions
If ``mkfs`` is ``True``, then a new filesystem is created if one does not
already exist.
To unmount a device, pass ``None`` as the device and the mount location
as ``mountpoint``.
.. function:: repl_uart(uart)
Get or set the UART object where the REPL is repeated on.