Skip to content

Commit d112dfa

Browse files
jonhpdevyte
authored andcommitted
Update readme.rst (#4131)
* 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).
1 parent 99d2890 commit d112dfa

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

doc/ota_updates/readme.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,15 @@ Basic Requirements
5757

5858
Flash chip size should be able to hold the old sketch (currently running) and the new sketch (OTA) at the same time.
5959

60-
Keep in mind that the File system and EEPROM for example needs space too (one time) see `flash layout <../filesystem.rst#flash-layout>`__.
60+
Keep in mind that the File system and EEPROM for example needs space too (one time) see :ref:`Flash layout`.
6161

6262
.. code:: cpp
6363
6464
ESP.getFreeSketchSpace();
6565
6666
can be used for checking the free space for the new sketch.
6767

68-
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>`__.
68+
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>`__.
6969

7070
The following chapters provide more details and specific methods of doing OTA.
7171

@@ -224,9 +224,9 @@ Instead of the log as on the above screen you may see the following:
224224

225225
If this is the case, then most likely ESP module has not been reset after initial upload using serial port.
226226

227-
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.
227+
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.
228228

229-
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>`__.
229+
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>`__.
230230

231231
Web Browser
232232
-----------

0 commit comments

Comments
 (0)