瀏覽代碼

docs: update readme and power management cn trans

intern 3 年之前
父節點
當前提交
e43bf8510b
共有 4 個文件被更改,包括 11 次插入13 次删除
  1. 3 5
      README.md
  2. 3 5
      README_CN.md
  3. 2 2
      docs/en/api-reference/system/power_management.rst
  4. 3 1
      docs/zh_CN/api-reference/system/power_management.rst

+ 3 - 5
README.md

@@ -32,11 +32,9 @@ See https://idf.espressif.com/ for links to detailed instructions on how to set
 
 ### Non-GitHub forks
 
-ESP-IDF uses relative locations as its submodules URLs ([.gitmodules](.gitmodules)). So they link to GitHub.
-If ESP-IDF is forked to a Git repository which is not on GitHub, you will need to run the script
-[tools/set-submodules-to-github.sh](tools/set-submodules-to-github.sh) after git clone.
-The script sets absolute URLs for all submodules, allowing `git submodule update --init --recursive` to complete.
-If cloning ESP-IDF from GitHub, this step is not needed.
+ESP-IDF uses relative locations as its submodules URLs ([.gitmodules](.gitmodules)). So they link to GitHub. If ESP-IDF is forked to a Git repository which is not on GitHub, you will need to run the script [tools/set-submodules-to-github.sh](tools/set-submodules-to-github.sh) after git clone.
+
+The script sets absolute URLs for all submodules, allowing `git submodule update --init --recursive` to complete. If cloning ESP-IDF from GitHub, this step is not needed.
 
 ## Finding a Project
 

+ 3 - 5
README_CN.md

@@ -6,7 +6,7 @@ ESP-IDF 是乐鑫官方推出的物联网开发框架,支持 Windows、Linux 
 
 # ESP-IDF 与乐鑫芯片
 
-下表总结了乐鑫芯片在 ESP-IDF 各版本中的支持状态,其中 ![alt text][supported] 代表已支持,![alt text][preview] 代表目前处于预览支持状态。在预览支持阶段,因为新芯片尚未完全添加到构建系统目录,所以一些重要的内容(如文档和技术规格书等)可能会缺失。请确保使用与芯片相匹配的 ESP-IDF 版本。
+下表总结了乐鑫芯片在 ESP-IDF 各版本中的支持状态,其中 ![alt text][supported] 代表已支持,![alt text][preview] 代表目前处于预览支持状态。预览支持状态通常有时间限制,而且仅适用于测试版芯片。请确保使用与芯片相匹配的 ESP-IDF 版本。
 
 |    芯片     |         v3.3           |           v4.1         |          v4.2          |         v4.3           |          v4.4          |          v5.0          |                                                            |
 |:----------- |:---------------------: | :---------------------:| :---------------------:| :---------------------:| :---------------------:| :---------------------:|:---------------------------------------------------------- |
@@ -32,11 +32,9 @@ ESP-IDF 是乐鑫官方推出的物联网开发框架,支持 Windows、Linux 
 
 ### 非 GitHub 分叉的 ESP-IDF 项目
 
-ESP-IDF 中的子模块采用相对路径([详见 .gitmodules 文件](.gitmodules)),所以它们会指向 GitHub。
-如果 ESP-IDF 被分叉到的仓库不在 GitHub 上,那么你需要在克隆结束后运行该脚本 [tools/set-submodules-to-github.sh](tools/set-submodules-to-github.sh)。
+ESP-IDF 中的子模块采用相对路径([详见 .gitmodules 文件](.gitmodules)),所以它们会指向 GitHub。 如果 ESP-IDF 被分叉到的仓库不在 GitHub 上,那么你需要在克隆结束后运行该脚本 [tools/set-submodules-to-github.sh](tools/set-submodules-to-github.sh)。
 
-这个脚本会为所有的子模块设置绝对路径,接着可以通过 `git submodule update --init --recursive` 完成子模块的更新。
-如果 ESP-IDF 是从 GitHub 上克隆得到,则不需要此步骤。
+这个脚本会为所有的子模块设置绝对路径,接着可以通过 `git submodule update --init --recursive` 完成子模块的更新。如果 ESP-IDF 是从 GitHub 上克隆得到,则不需要此步骤。
 
 ## 寻找项目
 

+ 2 - 2
docs/en/api-reference/system/power_management.rst

@@ -90,7 +90,7 @@ If none of the locks are acquired, and light sleep is enabled in a call to :cpp:
 
 Light sleep duration will be chosen to wake up the chip before the nearest event (task being unblocked, or timer elapses).
 
-To skip unnecessary wake-up you can consider initializing an esp_timer with the `skip_unhandled_events` option as true. Timers with this flag will not wake up the system and it helps to reduce consumption.
+To skip unnecessary wake-up, you can consider initializing an esp_timer with the `skip_unhandled_events` option as true. Timers with this flag will not wake up the system and it helps to reduce consumption.
 
 
 Dynamic Frequency Scaling and Peripheral Drivers
@@ -130,7 +130,7 @@ The following peripheral drivers are not aware of DFS yet. Applications need to
 
     - PCNT
     - Sigma-delta
-    - The legacy timer group driver (note, the new :doc:`GPTimer <../peripherals/gptimer>` will hold the ``ESP_PM_APB_FREQ_MAX`` lock while the timer is working, if the clock source is set to APB)
+    - The legacy timer group driver
     :SOC_MCPWM_SUPPORTED: - MCPWM
 
 API Reference

+ 3 - 1
docs/zh_CN/api-reference/system/power_management.rst

@@ -103,6 +103,8 @@ ESP-IDF 中集成的电源管理算法可以根据应用程序组件的需求,
 - **UART**:如果 REF_TICK 用作时钟源,则 UART 不受 APB 频率变更影响。请查看 :cpp:class:`uart_config_t` 中的 `use_ref_tick`。
 - **LEDC**:如果 REF_TICK 用作时钟源,则 LEDC 不受 APB 频率变更影响。请查看 :cpp:func:`ledc_timer_config` 函数。
 - **RMT**:如果 REF_TICK 或者 XTAL 被用作时钟源,则 RMT 不受 APB 频率变更影响。请查看 :cpp:class:`rmt_config_t` 结构体中的 `flags` 成员以及 `RMT_CHANNEL_FLAGS_AWARE_DFS` 宏。
+- **GPTimer**:如果 XTAL 用作时钟源,则 GPTimer 不受 APB 频率变更影响。请查看 :c:type:`gptimer_config_t` 结构体中的 :c:member:`clk_src` 成员。
+- **TSENS**:XTAL 或 RTC_8M 用作时钟源,因此不受 APB 频率变化影响。
 
 目前以下外设驱动程序可感知动态调频,并在调频期间使用 ``ESP_PM_APB_FREQ_MAX`` 锁:
 
@@ -128,7 +130,7 @@ ESP-IDF 中集成的电源管理算法可以根据应用程序组件的需求,
 
     - PCNT
     - Sigma-delta
-    - Timer group
+    - 旧版定时器驱动(Timer Group)
     :SOC_MCPWM_SUPPORTED: - MCPWM
 
 API 参考