alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'docs/add_read_otadata_documentation' into 'master'

Browse Source 
docs: Add documentation for `idf.py read-otadata`

See merge request espressif/esp-idf!28141
This commit is contained in:
Mahavir Jain 2024-01-15 13:00:23 +08:00
commit fd9cf82965
2 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/en/api-guides/tools/idf-py.rst
View File

@ -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
==============

9
docs/zh_CN/api-guides/tools/idf-py.rst
View File

@ -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`。
全局选项
==============