From f9d6cb70996d60cc8740db488cf0ea522ce2f89e Mon Sep 17 00:00:00 2001 From: Matus Fabo Date: Wed, 29 Sep 2021 14:24:10 +0200 Subject: [PATCH] add: spiffs issues documentation Issues documented: - SPIFFS is unable to utilize 100% of partition space - Long time between write function calls - Memory leaks when deleting file JIRA IDF-3776 --- docs/en/api-reference/storage/spiffs.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/en/api-reference/storage/spiffs.rst b/docs/en/api-reference/storage/spiffs.rst index e17bc1f06a..adebaf6934 100644 --- a/docs/en/api-reference/storage/spiffs.rst +++ b/docs/en/api-reference/storage/spiffs.rst @@ -14,6 +14,9 @@ Notes - Currently, SPIFFS does not support directories, it produces a flat structure. If SPIFFS is mounted under ``/spiffs``, then creating a file with the path ``/spiffs/tmp/myfile.txt`` will create a file called ``/tmp/myfile.txt`` in SPIFFS, instead of ``myfile.txt`` in the directory ``/spiffs/tmp``. - It is not a real-time stack. One write operation might take much longer than another. - For now, it does not detect or handle bad blocks. + - SPIFFS is able to reliably utilize only around 75% of assigned partition space. + - When the filesystem is running out of space, the garbage collector is trying to find free space by scanning the filesystem multiple times, which can take up to a few seconds per write function call, depending on required space. + - Deleting files does not always delete the whole file, which leaves unusable sections throughout the filesystem. Tools -----