From a51fe89778a4f006e520ada267acfe40d8b4b095 Mon Sep 17 00:00:00 2001 From: Matt Phillips Date: Mon, 21 Oct 2019 23:41:05 -0500 Subject: [PATCH] Update OTA Documentation to clarify grammar. The sentence about CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE was worded strangely. I updated it to better explain the functionality. Closes https://github.com/espressif/esp-idf/pull/4228 --- docs/en/api-reference/system/ota.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/api-reference/system/ota.rst b/docs/en/api-reference/system/ota.rst index ff9251c2cc..b3e3b08fd2 100644 --- a/docs/en/api-reference/system/ota.rst +++ b/docs/en/api-reference/system/ota.rst @@ -41,7 +41,7 @@ The main purpose of the application rollback is to keep the device working after * The application works fine, :cpp:func:`esp_ota_mark_app_valid_cancel_rollback` marks the running application with the state ``ESP_OTA_IMG_VALID``. There are no restrictions on booting this application. * The application has critical errors and further work is not possible, a rollback to the previous application is required, :cpp:func:`esp_ota_mark_app_invalid_rollback_and_reboot` marks the running application with the state ``ESP_OTA_IMG_INVALID`` and reset. This application will not be selected by the bootloader for boot and will boot the previously working application. -* If the :ref:`CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE` option is set, and occur a reset without calling either function then happend and is rolled back. +* If the :ref:`CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE` option is set, and a reset occurs without calling either function then the application is rolled back. Note: The state is not written to the binary image of the application it is written to the ``otadata`` partition. The partition contains a ``ota_seq`` counter which is a pointer to the slot (ota_0, ota_1, ...) from which the application will be selected for boot.