diff --git a/docs/en/contribute/install-pre-commit-hook.rst b/docs/en/contribute/install-pre-commit-hook.rst index 98d76a84a3..17a69bd6ef 100644 --- a/docs/en/contribute/install-pre-commit-hook.rst +++ b/docs/en/contribute/install-pre-commit-hook.rst @@ -6,7 +6,7 @@ Install Pre-commit Hook for ESP-IDF Project Install ``pre-commit`` ---------------------- -Run ``pip install pre-commit`` +Run ``pip install pre-commit``. Install ``pre-commit`` Hook --------------------------- @@ -20,10 +20,10 @@ Install ``pre-commit`` Hook Uninstall ``pre-commit`` Hook ----------------------------- -Run ``pre-commit uninstall`` +Run ``pre-commit uninstall``. -What Is More? -------------- +Related Documents +------------------- For detailed usage, please refer to the documentation of pre-commit_. @@ -34,17 +34,17 @@ Common Problems For Windows Users ``/usr/bin/env: python: Permission denied.`` - If you are in Git Bash, please check the python executable location by run ``which python``. + If you are in Git Bash, please check the python executable location by run ``which python``. - If the executable is under ``~/AppData/Local/Microsoft/WindowsApps/``, then it is a link to Windows AppStore, not a real one. + If the executable is under ``~/AppData/Local/Microsoft/WindowsApps/``, then it is a link to Windows AppStore, not a real one. - Please install Python manually and update this in your ``PATH`` environment variable. + Please install Python manually and update this in your ``PATH`` environment variable. Your ``USERPROFILE`` contains non-ASCII characters - ``pre-commit`` may fail when initializing an environment for a particular hook when the path of ``pre-commit``'s cache contains non-ASCII characters. The solution is to set ``PRE_COMMIT_HOME`` to a path containing only standard characters before running pre-commit. + ``pre-commit`` may fail when initializing an environment for a particular hook when the path of ``pre-commit``'s cache contains non-ASCII characters. The solution is to set ``PRE_COMMIT_HOME`` to a path containing only standard characters before running pre-commit. - - CMD: ``set PRE_COMMIT_HOME=C:\somepath\pre-commit`` - - PowerShell: ``$Env:PRE_COMMIT_HOME = "C:\somepath\pre-commit"`` - - git bash: ``export PRE_COMMIT_HOME="/c/somepath/pre-commit"`` + - CMD: ``set PRE_COMMIT_HOME=C:\somepath\pre-commit`` + - PowerShell: ``$Env:PRE_COMMIT_HOME = "C:\somepath\pre-commit"`` + - git bash: ``export PRE_COMMIT_HOME="/c/somepath/pre-commit"`` diff --git a/docs/en/migration-guides/release-5.x/5.4/system.rst b/docs/en/migration-guides/release-5.x/5.4/system.rst index ae7414bf5d..e6e0ede015 100644 --- a/docs/en/migration-guides/release-5.x/5.4/system.rst +++ b/docs/en/migration-guides/release-5.x/5.4/system.rst @@ -9,9 +9,8 @@ Log - `esp_log_buffer_hex` is deprecated, use `ESP_LOG_BUFFER_HEX` instead. - `esp_log_buffer_char` is deprecated, use `ESP_LOG_BUFFER_CHAR` instead. -ESP rom ---- +ESP ROM +--------- -- All target-specific header files has been moved from `components/esp_rom/include/{target}/` to `/esp_rom/{target}/include/{target}/`, and `components/esp_rom/CMakeLists.txt` has been modified accordingly. If you encounter an error indicating a missing header file, such as ``fatal error: esp32s3/rom/efuse.h: No such file or directory``, try removing the leading relative path from the header file include statement. In your current and future development, when including any header files from the components/esp_rom folder, directly include the header file name without the target-specific relative folder path. +- All target-specific header files has been moved from `components/esp_rom/include/{target}/` to `/esp_rom/{target}/include/{target}/`, and `components/esp_rom/CMakeLists.txt` has been modified accordingly. If you encounter an error indicating a missing header file, such as ``fatal error: esp32s3/rom/efuse.h: No such file or directory``, try removing the leading relative path from the header file include command. In your current and future development, when including any header files located in `components/esp_rom` path, directly use the header file name without the chip-specific relative folder path. - All target-specific `rom/miniz.h` files are removed because they are deprecated. - diff --git a/docs/zh_CN/contribute/install-pre-commit-hook.rst b/docs/zh_CN/contribute/install-pre-commit-hook.rst index bf4fec4bb2..cf87e210fa 100644 --- a/docs/zh_CN/contribute/install-pre-commit-hook.rst +++ b/docs/zh_CN/contribute/install-pre-commit-hook.rst @@ -1,9 +1,8 @@ 为 ESP-IDF 安装 pre-commit 钩子 -========================================== +=================================== :link_to_translation:`en:[English]` - 安装 ``pre-commit`` 工具 --------------------------- @@ -23,7 +22,7 @@ 运行 ``pre-commit uninstall`` 。 -更多 +相关文档 --------- 更多详细使用方法，请参考 pre-commit_ 文档。 @@ -31,7 +30,7 @@ .. _pre-commit: https://pre-commit.com/ Windows 用户常见问题 --------------------------------- +----------------------- ``/usr/bin/env: python: Permission denied.`` diff --git a/docs/zh_CN/migration-guides/release-5.x/5.4/system.rst b/docs/zh_CN/migration-guides/release-5.x/5.4/system.rst index 3644a6ea43..dbe6984ddd 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.4/system.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.4/system.rst @@ -3,8 +3,14 @@ :link_to_translation:`en:[English]` -Log ---- +日志 +------ - `esp_log_buffer_hex` 已弃用，应使用 `ESP_LOG_BUFFER_HEX` 替代。 - `esp_log_buffer_char` 已弃用，应使用 `ESP_LOG_BUFFER_CHAR` 替代。 + +ESP ROM +--------- + +- 针对特定目标的头文件已从 `components/esp_rom/include/{target}/` 移至 `/esp_rom/{target}/include/{target}/`，`components/esp_rom/CMakeLists.txt` 文件已相应更新。如果遇到报错提示缺少头文件，例如 ``fatal error: esp32s3/rom/efuse.h: No such file or directory``，请在头文件包含命令中删除前导的相对路径。在今后的开发中，如果需要包含 `components/esp_rom` 路径下的任何头文件，请直接使用头文件名，无需包含特定芯片的相对文件夹路径。 +- 所有特定目标的 `rom/miniz.h` 文件已移除，因为它们已经被弃用。