Skip to content

Commit

Permalink
Doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
tobozo committed Jan 21, 2021
1 parent e4cffea commit 5afbe73
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -303,13 +303,15 @@ Return Codes
- `-104` : Gzip dictionnary needs to be enabled
- `-105` : Gz Error when parsing header
- `-106` : Gz Error when allocating memory
- `-107` : General error, file integrity check fail
- UZLIB: forwarding error values from uzlib.h as is (no offset)
- `-2` : Not a valid gzip file
- `-3` : Gz Error TINF_DATA_ERROR
- `-4` : Gz Error TINF_CHKSUM_ERROR
- `-5` : Gz Error TINF_DICT_ERROR
- `-41` : Gz error, can't guess filename
- UPDATE: applying -20 offset to forwarded error values from Update.h
Expand Down Expand Up @@ -347,7 +349,6 @@ Test Suite
Known bugs
----------
- tarGzExpander/tarExpander: some formats aren't supported with SPIFFS (e.g contains symlinks or long filename/path)
- tarGzExpander/gzExpander on ESP8266 : while the provided examples will work, the 32Kb dynamic allocation for gzip dictionary is unlikely to work in real world scenarios (e.g. with a webserver) and would probably require static allocation
Expand All @@ -356,14 +357,22 @@ Known bugs
- ~~.tar files containing files smaller than 512 bytes aren't fully processed~~
- ~~reading/writing simultaneously on SPIFFS may induce errors~~
Debugging:
----------
- ESP32: use all of the "Debug level" values from the boards menu
- ESP8266: Warning/Error when "Debug Port:Serial" is used, and Debug/Verbose when "Debug Level:Core" is selected from the boards menu
Resources
-----------
- [LittleFS for ESP32](https://github.com/lorol/LITTLEFS)
- [ESP8266 Sketch Data Upload tool for LittleFS](https://github.com/earlephilhower/arduino-esp8266littlefs-plugin)
- [ESP32 Sketch Data Upload tool for FFat/LittleFS/SPIFFS/](https://github.com/lorol/arduino-esp32fs-plugin/releases)
![image](https://user-images.githubusercontent.com/1893754/99714053-635de380-2aa5-11eb-98e3-631a94836742.png)
- [LittleFS for ESP32](https://github.com/lorol/LITTLEFS)
Credits:
--------
Expand Down

0 comments on commit 5afbe73

Please sign in to comment.