arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-04-21 10:26:06 +03:00
Code

Update readme.rst (#4131)

Browse Source 
* Update readme.rst

fix broken link to file system flash layout

* linkage repair

my second shot at fixing the external page link for "flash layout". It appears that the on-page link to "Update Process - Memory View" was broken (not sure if I got this one right or not).
This commit is contained in:
Jon H Peterson 2018-03-19 08:42:53 -05:00 committed by Develo
parent 99d28902fb
commit d112dfa476
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/ota_updates/readme.rst
View File

@ -57,7 +57,7 @@ Basic Requirements
Flash chip size should be able to hold the old sketch (currently running) and the new sketch (OTA) at the same time. Flash chip size should be able to hold the old sketch (currently running) and the new sketch (OTA) at the same time.
Keep in mind that the File system and EEPROM for example needs space too (one time) see `flash layout <../filesystem.rst#flash-layout>`__. Keep in mind that the File system and EEPROM for example needs space too (one time) see :ref:`Flash layout`.
.. code:: cpp .. code:: cpp
@ -65,7 +65,7 @@ Keep in mind that the File system and EEPROM for example needs space too (one ti
can be used for checking the free space for the new sketch. can be used for checking the free space for the new sketch.
For overview of memory layout, where new sketch is stored and how it is copied during OTA process, see `Update process - memory view <#update-process---memory-view>`__. For overview of memory layout, where new sketch is stored and how it is copied during OTA process, see `Update process - memory view <#update-process-memory-view>`__.
The following chapters provide more details and specific methods of doing OTA. The following chapters provide more details and specific methods of doing OTA.
@ -224,9 +224,9 @@ Instead of the log as on the above screen you may see the following:
If this is the case, then most likely ESP module has not been reset after initial upload using serial port. If this is the case, then most likely ESP module has not been reset after initial upload using serial port.
The most common causes of OTA failure are as follows: \* not enough physical memory on the chip (e.g. ESP01 with 512K flash memory is not enough for OTA), \* too much memory declared for SPIFFS so new sketch will not fit between existing sketch and SPIFFS – see `Update process - memory view <#update-process---memory-view>`__, \* too little memory declared in Arduino IDE for your selected board (i.e. less than physical size), \* not resetting the ESP module after initial upload using serial port. The most common causes of OTA failure are as follows: \* not enough physical memory on the chip (e.g. ESP01 with 512K flash memory is not enough for OTA), \* too much memory declared for SPIFFS so new sketch will not fit between existing sketch and SPIFFS – see `Update process - memory view <#update-process-memory-view>`__, \* too little memory declared in Arduino IDE for your selected board (i.e. less than physical size), \* not resetting the ESP module after initial upload using serial port.
For more details regarding flash memory layout please check `File system <../filesystem.rst>`__. For overview where new sketch is stored, how it is copied and how memory is organized for the purpose of OTA see `Update process - memory view <#update-process---memory-view>`__. For more details regarding flash memory layout please check `File system <../filesystem.rst>`__. For overview where new sketch is stored, how it is copied and how memory is organized for the purpose of OTA see `Update process - memory view <#update-process-memory-view>`__.
Web Browser Web Browser
----------- -----------