From 18947904bc81838a4cdc524edb969ab605ce0a4f Mon Sep 17 00:00:00 2001 From: Harshit Malpani Date: Wed, 27 Dec 2023 11:54:58 +0530 Subject: [PATCH] docs: Add documentation for `idf.py read-otadata` --- docs/en/api-guides/tools/idf-py.rst | 9 +++++++++ docs/zh_CN/api-guides/tools/idf-py.rst | 9 +++++++++ 2 files changed, 18 insertions(+) diff --git a/docs/en/api-guides/tools/idf-py.rst b/docs/en/api-guides/tools/idf-py.rst index c785b7a212..58dff40865 100644 --- a/docs/en/api-guides/tools/idf-py.rst +++ b/docs/en/api-guides/tools/idf-py.rst @@ -218,6 +218,15 @@ To generate a UF2 binary for the application only (not including the bootloader idf.py uf2-app +Read Otadata Partition: ``read-otadata`` +---------------------------------------- + +.. code-block:: bash + + idf.py read-otadata + +This command prints the contents of the ``otadata`` partition which stores the information about the currently selected OTA app slot. Refer to :doc:`/api-reference/system/ota` for more about the ``otadata`` partition. + Global Options ============== diff --git a/docs/zh_CN/api-guides/tools/idf-py.rst b/docs/zh_CN/api-guides/tools/idf-py.rst index 38162c5bca..ef7696f56f 100644 --- a/docs/zh_CN/api-guides/tools/idf-py.rst +++ b/docs/zh_CN/api-guides/tools/idf-py.rst @@ -218,6 +218,15 @@ ESP-IDF 支持多个目标芯片，运行 ``idf.py --list-targets`` 查看当前 idf.py uf2-app +读取 Otadata 分区：``read-otadata`` +-------------------------------------- + +.. code-block:: bash + + idf.py read-otadata + +此命令将打印 ``otadata`` 分区的内容，该分区存储当前所选 OTA 应用程序分区的信息。有关 ``otadata`` 分区的更多信息，请参阅 :doc:`/api-reference/system/ota`。 + 全局选项 ==============