History

YAMAMOTO Takashi b3d36219e4 spiffs: Document how to generate images		2021-01-06 03:06:39 -06:00
..
docs	Run codespell -w with the latest dictonary again	2020-02-23 22:27:46 +01:00
src	spiffs: Prefix filenames with '/' as other implmenetations do	2021-01-06 03:06:39 -06:00
Kconfig	spiffs/Kconfig: Mention that CONFIG_SPIFFS_MAX_NAME is an on-flash thing	2021-01-06 03:06:39 -06:00
Make.defs	Change all 'Nuttx' to 'NuttX'	2020-10-20 01:45:06 -07:00
README-spiffs.md	spiffs: Rename the upsteam readme to README-spiffs.md	2021-01-06 03:06:39 -06:00
README.md	spiffs: Document how to generate images	2021-01-06 03:06:39 -06:00

README.md

SPIFFS

Creating an image

This implementation is supposed to be compatible with images generated by the following tools:

mkspiffs https://github.com/igrr/mkspiffs
ESP-IDF spiffsgen.py https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/storage/spiffs.html#spiffsgen-py

Note: please ensure the following NuttX configs to be compatible with these tools:

CONFIG_SPIFFS_COMPAT_OLD_NUTTX is disabled
CONFIG_SPIFFS_LEADING_SLASH=y

mkspiffs

Specify CONFIG_SPIFFS_NAME_MAX + 1 for SPIFFS_OBJ_NAME_LEN.
Specify 0 for SPIFFS_OBJ_META_LEN.

ESP-IDF spiffsgen.py

Specify CONFIG_SPIFFS_NAME_MAX + 1 for the --obj-name-len option.
Specify 0 for the --meta-len option.