Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Provide CN translation for settings.rst #1341

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Provide CN translation for settings.rst #1341

wants to merge 1 commit into from

Conversation

Shen765
Copy link
Collaborator

@Shen765 Shen765 commented Nov 13, 2024

Description

This PR:

  • Adjusted some format issues and unclear expressions in settings.rst based on Espressif Style Guide
  • Provided CN translation for settings.rst
  • TODO: Closes DOC-9380 once merged

@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 13, 2024 •
edited
Loading

Download the artifacts for this pull request:
You can test these changes by installing this VSIX by click menu View -> Command Palette..., type Install from VSIX and then select downloaded esp-idf-extension.vsix file to install the extension.

@Shen765 Shen765 force-pushed the docs/translate_settings branch 4 times, most recently from 3174d75 to 3674c3e Compare November 14, 2024 09:14
@Shen765 Shen765 self-assigned this Nov 14, 2024
@Shen765 Shen765 added the documentation 📝 Solely about the documentation of the project. label Nov 14, 2024
0cici
0cici reviewed Nov 15, 2024
View reviewed changes
docs_espressif/zh_CN/settings.rst Outdated Show resolved Hide resolved
docs_espressif/zh_CN/settings.rst Outdated Show resolved Hide resolved
docs_espressif/zh_CN/settings.rst Outdated Show resolved Hide resolved
docs_espressif/zh_CN/settings.rst Outdated Show resolved Hide resolved
docs_espressif/zh_CN/settings.rst Outdated Show resolved Hide resolved
docs_espressif/en/settings.rst Outdated Show resolved Hide resolved
docs_espressif/en/settings.rst Outdated
3. **idf.openOcdConfigs** is used to store an string array of OpenOCD scripts directory relative path config files to use with OpenOCD server. (Example: ``["interface/ftdi/esp32_devkitj_v1.cfg", "board/esp32-wrover.cfg"]``). More information `OpenOCD JTAG Target configuration <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/tips-and-quirks.html#jtag-debugging-tip-openocd-configure-target>`_.
1. **idf.flashBaudRate** is the baud rate value used for the **ESP-IDF: Flash your Project** command and `Debugging <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/DEBUGGING.md>`_.
2. **idf.monitorBaudRate** is the ESP-IDF Monitor baud rate value and fallback from your project's sdkconfig ``CONFIG_ESPTOOLPY_MONITOR_BAUD`` (idf.py monitor' baud rate). This value can also be override by setting the environment variable ``IDF_MONITOR_BAUD`` or ``MONITORBAUD`` in your system environment variables or this extension's **idf.customExtraVars** configuration setting.
3. **idf.openOcdConfigs** is used to store an string array of OpenOCD scripts directory relative path config files to use with OpenOCD server. (e.g.，``["interface/ftdi/esp32_devkitj_v1.cfg", "board/esp32-wrover.cfg"]``). More information can be found in `OpenOCD JTAG Target Configuration <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/tips-and-quirks.html#jtag-debugging-tip-openocd-configure-target>`_.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
3. **idf.openOcdConfigs** is used to store an string array of OpenOCD scripts directory relative path config files to use with OpenOCD server. (e.g.，``["interface/ftdi/esp32_devkitj_v1.cfg", "board/esp32-wrover.cfg"]``). More information can be found in `OpenOCD JTAG Target Configuration <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/tips-and-quirks.html#jtag-debugging-tip-openocd-configure-target>`_.
3. **idf.openOcdConfigs** stores an array of relative paths to OpenOCD script configuration files used with the OpenOCD server. (e.g.，``["interface/ftdi/esp32_devkitj_v1.cfg", "board/esp32-wrover.cfg"]``). More information can be found in `OpenOCD JTAG Target Configuration <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/tips-and-quirks.html#jtag-debugging-tip-openocd-configure-target>`_.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @0cici. I asked GPT to polish this sentence and make it clearer. Pls check the updated sentence along with its corresponding Chinese translation. Thx!

Hi @brianignacio5. Pls pay attention to this sentence when reviewing the updated English file. I hope the original meaning has not been altered. Thx!

docs_espressif/en/settings.rst Outdated Show resolved Hide resolved
docs_espressif/zh_CN/settings.rst Outdated Show resolved Hide resolved
@0cici
Copy link

0cici commented Nov 15, 2024

Hi @Shen765 , thanks for translating the file! Left a few suggestions, please take a look~

zztiger123
zztiger123 reviewed Nov 18, 2024
View reviewed changes
docs_espressif/zh_CN/settings.rst Outdated

扩展将按照以下方式使用上述设置：

1. **idf.flashBaudRate** 是用于 **ESP-IDF：烧录项目** 命令和 `Debugging <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/DEBUGGING.md>`_ 的烧录速率。
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里和之前的想法一样，个人不认为也要把 ESP-IDF: Flash your Project 命令翻译成中文，而且这里的 调试 文档是不是以后还要附上中文翻译文档链接

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @zztiger123 The author has updated this link to point to a website page. Currently, this page is only available in English. If we replace "en" in the link with "zh_CN", it will turn 404. So, do you think it would be better to edit the link now in case we forget to revise it later when CN page is available, or should we use the same link as in the EN doc?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can use the same link as in the EN doc now.

zztiger123
zztiger123 reviewed Nov 18, 2024
View reviewed changes
docs_espressif/zh_CN/settings.rst
* - **idf.enableStatusBar**
- 显示或隐藏扩展状态栏项目
* - **idf.enableSizeTaskAfterBuildTask**
- 在完成 IDF 构建任务后执行 IDF 计算程序大小任务
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

不知道这里的 IDF Size Task 是不是 extension 里特制的。没完全理解，可以找 brain 补充几个单词说明下

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

难道是 idf.py size?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

估计是 building log 后面的 size_info.txt like this:
image

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @brianignacio5
Could you clarify what "IDF Size Task" refers to in this document? Could you please make it more specific?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@0cici 0cici 0cici left review comments

@zztiger123 zztiger123 zztiger123 approved these changes

@brianignacio5 brianignacio5 Awaiting requested review from brianignacio5

Assignees

@Shen765 Shen765

Labels
documentation 📝 Solely about the documentation of the project.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Shen765 @0cici @zztiger123