Skip to content

Commit

Permalink
Merge branch 'docs/format_application_example_bootloader' into 'master'
Browse files Browse the repository at this point in the history
docs: format application examples for bootloader.rst

See merge request espressif/esp-idf!33680
  • Loading branch information
suda-morris committed Sep 25, 2024
2 parents 004e427 + acbbacb commit 814d583
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/en/api-guides/bootloader.rst
Original file line number Diff line number Diff line change
Expand Up @@ -181,8 +181,8 @@ Custom Bootloader

The current bootloader implementation allows a project to extend it or modify it. There are two ways of doing it: by implementing hooks or by overriding it. Both ways are presented in :example:`custom_bootloader` folder in ESP-IDF examples:

* `bootloader_hooks` which presents how to connect some hooks to the bootloader initialization
* `bootloader_override` which presents how to override the bootloader implementation
* :example:`custom_bootloader/bootloader_hooks` presents how to connect some hooks to the bootloader initialization
* :example:`custom_bootloader/bootloader_override` presents how to override the bootloader implementation

In the bootloader space, you cannot use the drivers and functions from other components. If necessary, then the required functionality should be placed in the project's `bootloader_components` directory (note that this will increase its size).

Expand Down
4 changes: 2 additions & 2 deletions docs/zh_CN/api-guides/bootloader.rst
Original file line number Diff line number Diff line change
Expand Up @@ -181,8 +181,8 @@ ROM 中的 :ref:`first-stage-bootloader` 从 flash 中读取 :ref:`second-stage-

用户可以扩展或修改当前的引导加载程序,具体有两种方法:使用钩子实现或重写覆盖当前程序。这两种方法在 ESP-IDF 示例的 :example:`custom_bootloader` 文件夹中都有呈现。

* `bootloader_hooks` 介绍了如何将钩子与引导加载程序初始化连接。
* `bootloader_override` 介绍了如何覆盖引导加载程序的实现。
* :example:`custom_bootloader/bootloader_hooks` 介绍了如何将钩子与引导加载程序初始化连接。
* :example:`custom_bootloader/bootloader_override` 介绍了如何覆盖引导加载程序的实现。

在引导加载程序的代码中,用户不能使用其他组件提供的驱动和函数,如果确实需要,请将该功能的实现部分放在项目的 `bootloader_components` 目录中(注意,这会增加引导加载程序的大小)。

Expand Down

0 comments on commit 814d583

Please sign in to comment.