aboutsummaryrefslogtreecommitdiff
path: root/docs/library/esp32.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/library/esp32.rst')
-rw-r--r--docs/library/esp32.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/library/esp32.rst b/docs/library/esp32.rst
index 856d9aef8..d6b4051a2 100644
--- a/docs/library/esp32.rst
+++ b/docs/library/esp32.rst
@@ -114,6 +114,11 @@ methods to enable over-the-air (OTA) updates.
Sets the partition as the boot partition.
+ .. note:: Do not enter :func:`deepsleep<machine.deepsleep>` after changing
+ the OTA boot partition, without first performing a hard
+ :func:`reset<machine.reset>` or power cycle. This ensures the bootloader
+ will validate the new image before booting.
+
.. method:: Partition.get_next_update()
Gets the next update partition after this one, and returns a new Partition object.