Skip to content

Commit d1df341

Browse files
April-Yjjerhankur
authored andcommitted
docs: Update CN translation
1 parent a877a07 commit d1df341

File tree

4 files changed

+36
-6
lines changed

4 files changed

+36
-6
lines changed

docs/en/api-guides/core_dump.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The :ref:`CONFIG_ESP_COREDUMP_MAX_TASKS_NUM` option configures the number of tas
3636
Data Integrity Check
3737
^^^^^^^^^^^^^^^^^^^^
3838

39-
Core dump files include a SHA256 checksum, which can be used to verify the integrity of the core dump file and ensure it has not been corrupted. The SHA256 hash algorithm provides a high probability of detecting corruption, including multiple-bit errors.
39+
Core dump files include a SHA256 checksum that verifies the integrity of the file and ensure it has not been corrupted. The SHA256 hash algorithm provides a high probability of detecting corruption, including multiple-bit errors.
4040

4141
Reserved Stack Size
4242
^^^^^^^^^^^^^^^^^^^

docs/en/migration-guides/release-6.x/6.0/system.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ The deprecated ``soc_memory_types.h`` header file has been removed. Please inclu
5757

5858
App Trace
5959
----------
60+
6061
Removed extra data buffering option. `CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX` is no longer supported.
6162

6263
Removed deprecated `ESP_APPTRACE_DEST_TRAX` enum value. Use `ESP_APPTRACE_DEST_JTAG` instead.
@@ -97,7 +98,7 @@ The function :cpp:func:`pxTaskGetStackStart` has been deprecated. Use :cpp:func:
9798
Core Dump
9899
---------
99100

100-
Binary data format has been dropped. `CONFIG_ESP_COREDUMP_DATA_FORMAT_BIN` is no longer supported. Elf is now the default data format.
101+
Binary data format has been dropped. `CONFIG_ESP_COREDUMP_DATA_FORMAT_BIN` is no longer supported. ELF is now the default data format.
101102

102103
CRC data integrity check has been dropped. `ESP_COREDUMP_CHECKSUM_CRC32` is no longer supported. SHA256 is now the default checksum algorithm.
103104

docs/zh_CN/api-guides/core_dump.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@
2929
格式和大小
3030
^^^^^^^^^^^^^
3131

32-
核心转储文件以 ELF 格式生成,该格式具备扩展特性,支持在发生崩溃时保存关于错误任务和崩溃软件的全面信息。ELF 格式足够灵活,可以在未来的修订版本中进行扩展,保存更多信息
32+
核心转储文件以 ELF 格式生成,该格式具有可扩展性,能够在系统崩溃时完整保存错误任务和故障软件的详细信息。ELF 格式具备良好的扩展灵活性,便于未来版本升级时存储更多诊断信息
3333

34-
选项 :ref:`CONFIG_ESP_COREDUMP_MAX_TASKS_NUM` 配置核心转储保存的任务快照数量
34+
选项 :ref:`CONFIG_ESP_COREDUMP_MAX_TASKS_NUM` 可用于配置核心转储保存的任务快照数量
3535

3636
数据完整性检查
3737
^^^^^^^^^^^^^^^^^^^^
3838

39-
核心转储文件包含 SHA256 校验和,用于验证核心转储文件的完整性并确保文件未被损坏。SHA256 哈希算法在检测损坏方面具有很高的准确率,包括多位错误。
39+
核心转储文件包含 SHA256 校验和,用于验证核心转储文件的完整性,确保文件未被损坏。SHA256 哈希算法在检测损坏方面具有很高的准确率,包括多位错误。
4040

4141

4242
保留栈大小

docs/zh_CN/migration-guides/release-6.x/6.0/system.rst

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,31 @@ Xtensa 特殊寄存器头文件已更新,使用新的命名约定。旧的 ``s
5555

5656
已弃用的头文件 ``soc_memory_types.h`` 已被移除,请改用替代头文件 ``esp_memory_utils.h``。
5757

58-
App Trace
58+
App 追踪
5959
----------
6060

6161
已移除额外数据缓冲选项。不再支持 `CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX` 配置项。
6262

63+
已移除弃用的 `ESP_APPTRACE_DEST_TRAX` 枚举值。请改用 `ESP_APPTRACE_DEST_JTAG`。
64+
65+
函数 :cpp:func:`esp_apptrace_down_buffer_config` 现在需要一个目标参数,并返回一个错误代码以便进行适当的错误处理。
66+
67+
旧代码:
68+
69+
.. code-block:: c
70+
71+
esp_apptrace_down_buffer_config(down_buf, sizeof(down_buf));
72+
73+
现在需要修改成:
74+
75+
.. code-block:: c
76+
77+
esp_err_t res = esp_apptrace_down_buffer_config(ESP_APPTRACE_DEST_JTAG, down_buf, sizeof(down_buf));
78+
if (res != ESP_OK) {
79+
ESP_LOGE(TAG, "Failed to config down buffer!");
80+
return res;
81+
}
82+
6383
FreeRTOS
6484
--------
6585

@@ -74,3 +94,12 @@ FreeRTOS
7494
**已弃用的函数**
7595

7696
函数 :cpp:func:`pxTaskGetStackStart` 已弃用。请使用 :cpp:func:`xTaskGetStackStart` 替代以提高类型安全性。
97+
98+
核心转储
99+
--------
100+
101+
二进制数据格式已被弃用。`CONFIG_ESP_COREDUMP_DATA_FORMAT_BIN` 表示该功能已完全删除,不再可用。现在默认的数据格式是 ELF。
102+
103+
CRC 数据完整性检查已被弃用。`ESP_COREDUMP_CHECKSUM_CRC32` 表示该功能已完全删除,不再可用。现在默认的校验和算法为 SHA256。
104+
105+
函数 :cpp:func:`esp_core_dump_partition_and_size_get()` 现在对空白(已擦除)分区返回 `ESP_ERR_NOT_FOUND`,而不是 `ESP_ERR_INVALID_SIZE`。

0 commit comments

Comments
 (0)