diff options
| author | Damien George <damien.p.george@gmail.com> | 2019-12-10 16:58:53 +1100 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2019-12-10 16:58:53 +1100 |
| commit | b310930dba3a35dbe4d790f461caf27d78b4c7b9 (patch) | |
| tree | d38b8f3a8d5d3373b41c28f5a74f7dcb3b75baee | |
| parent | 159388f85072af9aa704f48f6d75bea5b943178b (diff) | |
docs/library/uos: Add notes and links about littlefs failures.
| -rw-r--r-- | docs/library/uos.rst | 8 | ||||
| -rw-r--r-- | docs/reference/filesystem.rst | 7 |
2 files changed, 14 insertions, 1 deletions
diff --git a/docs/library/uos.rst b/docs/library/uos.rst index 84d341ac2..5505e6434 100644 --- a/docs/library/uos.rst +++ b/docs/library/uos.rst @@ -191,6 +191,9 @@ represented by VFS classes. Build a Lfs1 filesystem on *block_dev*. + .. note:: There are reports of littlefs v1 failing in certain situations, + for details see `littlefs issue 347`_. + .. class:: VfsLfs2(block_dev) Create a filesystem object that uses the `littlefs v2 filesystem format`_. @@ -204,8 +207,13 @@ represented by VFS classes. Build a Lfs2 filesystem on *block_dev*. + .. note:: There are reports of littlefs v2 failing in certain situations, + for details see `littlefs issue 295`_. + .. _littlefs v1 filesystem format: https://github.com/ARMmbed/littlefs/tree/v1 .. _littlefs v2 filesystem format: https://github.com/ARMmbed/littlefs +.. _littlefs issue 295: https://github.com/ARMmbed/littlefs/issues/295 +.. _littlefs issue 347: https://github.com/ARMmbed/littlefs/issues/347 Block devices ------------- diff --git a/docs/reference/filesystem.rst b/docs/reference/filesystem.rst index 32d013849..cd8600928 100644 --- a/docs/reference/filesystem.rst +++ b/docs/reference/filesystem.rst @@ -214,13 +214,18 @@ Littlefs Littlefs_ is a filesystem designed for flash-based devices, and is much more resistant to filesystem corruption. +.. note:: There are reports of littlefs v1 and v2 failing in certain + situations, for details see `littlefs issue 347`_ and + `littlefs issue 295`_. + Note: It can be still be accessed over USB MSC using the `littlefs FUSE driver`_. Note that you must use the ``-b=4096`` option to override the block size. .. _littlefs FUSE driver: https://github.com/ARMmbed/littlefs-fuse/tree/master/littlefs - .. _Littlefs: https://github.com/ARMmbed/littlefs +.. _littlefs issue 295: https://github.com/ARMmbed/littlefs/issues/295 +.. _littlefs issue 347: https://github.com/ARMmbed/littlefs/issues/347 To format the entire flash using littlefs v2:: |