diff options
| author | Damien George <damien@micropython.org> | 2023-11-20 19:12:02 +1100 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2024-02-07 13:25:09 +1100 |
| commit | 45f99cb4459248116396773a72cc122edbe14a00 (patch) | |
| tree | 20ca8e12879972b210aaca9b70728acc10f0c220 /docs/reference | |
| parent | e7020463f1114317988ffef21663df5cc8c62ba9 (diff) | |
| download | micropython-45f99cb4459248116396773a72cc122edbe14a00.tar.gz micropython-45f99cb4459248116396773a72cc122edbe14a00.zip | |
docs/library: Move vfs functions and classes from os to vfs module docs.
Signed-off-by: Damien George <damien@micropython.org>
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | docs/reference/filesystem.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/reference/filesystem.rst b/docs/reference/filesystem.rst index ca9e56344e..d8092c58dd 100644 --- a/docs/reference/filesystem.rst +++ b/docs/reference/filesystem.rst @@ -40,7 +40,7 @@ Block devices ------------- A block device is an instance of a class that implements the -:class:`os.AbstractBlockDev` protocol. +:class:`vfs.AbstractBlockDev` protocol. Built-in block devices ~~~~~~~~~~~~~~~~~~~~~~ @@ -116,8 +116,8 @@ It can be used as follows:: An example of a block device that supports both the simple and extended interface (i.e. both signatures and behaviours of the -:meth:`os.AbstractBlockDev.readblocks` and -:meth:`os.AbstractBlockDev.writeblocks` methods) is:: +:meth:`vfs.AbstractBlockDev.readblocks` and +:meth:`vfs.AbstractBlockDev.writeblocks` methods) is:: class RAMBlockDev: def __init__(self, block_size, num_blocks): @@ -148,7 +148,7 @@ interface (i.e. both signatures and behaviours of the return 0 As it supports the extended interface, it can be used with :class:`littlefs -<os.VfsLfs2>`:: +<vfs.VfsLfs2>`:: import os @@ -166,8 +166,8 @@ normally would be used from Python code, for example:: Filesystems ----------- -MicroPython ports can provide implementations of :class:`FAT <os.VfsFat>`, -:class:`littlefs v1 <os.VfsLfs1>` and :class:`littlefs v2 <os.VfsLfs2>`. +MicroPython ports can provide implementations of :class:`FAT <vfs.VfsFat>`, +:class:`littlefs v1 <vfs.VfsLfs1>` and :class:`littlefs v2 <vfs.VfsLfs2>`. The following table shows which filesystems are included in the firmware by default for given port/board combinations, however they can be optionally |