Skip to content

Commit b310930

Browse files
committed
docs/library/uos: Add notes and links about littlefs failures.
1 parent 159388f commit b310930

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

docs/library/uos.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,9 @@ represented by VFS classes.
191191

192192
Build a Lfs1 filesystem on *block_dev*.
193193

194+
.. note:: There are reports of littlefs v1 failing in certain situations,
195+
for details see `littlefs issue 347`_.
196+
194197
.. class:: VfsLfs2(block_dev)
195198

196199
Create a filesystem object that uses the `littlefs v2 filesystem format`_.
@@ -204,8 +207,13 @@ represented by VFS classes.
204207

205208
Build a Lfs2 filesystem on *block_dev*.
206209

210+
.. note:: There are reports of littlefs v2 failing in certain situations,
211+
for details see `littlefs issue 295`_.
212+
207213
.. _littlefs v1 filesystem format: https://github.com/ARMmbed/littlefs/tree/v1
208214
.. _littlefs v2 filesystem format: https://github.com/ARMmbed/littlefs
215+
.. _littlefs issue 295: https://github.com/ARMmbed/littlefs/issues/295
216+
.. _littlefs issue 347: https://github.com/ARMmbed/littlefs/issues/347
209217

210218
Block devices
211219
-------------

docs/reference/filesystem.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,13 +214,18 @@ Littlefs
214214
Littlefs_ is a filesystem designed for flash-based devices, and is much more
215215
resistant to filesystem corruption.
216216

217+
.. note:: There are reports of littlefs v1 and v2 failing in certain
218+
situations, for details see `littlefs issue 347`_ and
219+
`littlefs issue 295`_.
220+
217221
Note: It can be still be accessed over USB MSC using the `littlefs FUSE
218222
driver`_. Note that you must use the ``-b=4096`` option to override the block
219223
size.
220224

221225
.. _littlefs FUSE driver: https://github.com/ARMmbed/littlefs-fuse/tree/master/littlefs
222-
223226
.. _Littlefs: https://github.com/ARMmbed/littlefs
227+
.. _littlefs issue 295: https://github.com/ARMmbed/littlefs/issues/295
228+
.. _littlefs issue 347: https://github.com/ARMmbed/littlefs/issues/347
224229

225230
To format the entire flash using littlefs v2::
226231

0 commit comments

Comments
 (0)