espressif/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-04-27 19:13:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'fix/update_argument_file_docs' into 'master'

Browse Source 
docs(tools): Enclosed @argument_file with quotations

See merge request espressif/esp-idf!44803
This commit is contained in:
Marek Fiala
2026-01-16 16:26:27 +08:00
parent 33e08422b7 b48cb1c5a9
commit 93714b9dfd
2 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/api-guides/tools/idf-py.rst
+4 -3
View File
@@ -401,11 +401,11 @@ For example, let's have a file `custom_flash.txt`:
flash --baud 115200
Then the command can be executed as: ``idf.py @custom_flash.txt monitor``
Then the command can be executed as: ``idf.py "@custom_flash.txt" monitor``
Arguments from a file can be combined with additional command line arguments, and multiple files annotated with ``@`` can be used simultaneously. For instance, if there is a second file ``another_config.txt``, both can be utilized by specifying ``idf.py @custom_flash.txt @another_config.txt monitor``.
Arguments from a file can be combined with additional command line arguments, and multiple files annotated with ``@`` can be used simultaneously. For instance, if there is a second file ``another_config.txt``, both can be utilized by specifying ``idf.py "@custom_flash.txt" "@another_config.txt" monitor``.
A further example of how this argument file can be used, e.g., creating configuration profile files via @filename, is in the :example_file:`Multiple Build Configurations Example <build_system/cmake/multi_config/README.md>`.
A further example of how this argument file can be used, e.g., creating configuration profile files via @filename, is in the `Create configuration profile files <profile_file_>`_ paragraph in Multiple Build Configurations Example.
Extending ``idf.py``
====================
@@ -517,3 +517,4 @@ Basic Usage Examples
.. _CCache: https://ccache.dev/
.. _click context: https://click.palletsprojects.com/en/stable/api/#context
.. _CMake presets: https://cmake.org/cmake/help/latest/manual/cmake-presets.7.html
.. _profile_file: https://github.com/espressif/esp-idf/tree/release/v5.5/examples/build_system/cmake/multi_config#create-configuration-profile-files-via-filename
docs/zh_CN/api-guides/tools/idf-py.rst
+4 -3
View File
@@ -401,11 +401,11 @@ ESP-IDF 支持 `CMake presets`_ 以简化多个构建配置的管理。此功能
flash --baud 115200
运行命令：``idf.py @custom_flash.txt monitor``
运行命令：``idf.py "@custom_flash.txt" monitor``
文件中的参数可以与额外的命令行参数结合使用，也支持同时使用带有 ``@`` 标注的多个文件。例如，另有一个文件 ``another_config.txt``，此时，可以通过指定 ``idf.py @custom_flash.txt @another_config.txt monitor`` 同时使用两个文件。
文件中的参数可以与额外的命令行参数结合使用，也支持同时使用带有 ``@`` 标注的多个文件。例如，另有一个文件 ``another_config.txt``，此时，可以通过指定 ``idf.py "@custom_flash.txt" "@another_config.txt" monitor`` 同时使用两个文件。
关于参数文件的更多示例，如通过 @filename 创建配置文件概要，请参阅 :example_file:`多个构建配置示例 <build_system/cmake/multi_config/README.md>`。
关于参数文件的更多示例，如通过 @filename 创建配置文件概要，请参阅多个构建配置示例文档中的 `创建配置文件概要 <profile_file_>`_ 小节。
扩展 ``idf.py``
====================
@@ -517,3 +517,4 @@ ESP-IDF 支持 `CMake presets`_ 以简化多个构建配置的管理。此功能
.. _CCache: https://ccache.dev/
.. _click context: https://click.palletsprojects.com/en/stable/api/#context
.. _CMake presets: https://cmake.org/cmake/help/latest/manual/cmake-presets.7.html
.. _profile_file: https://github.com/espressif/esp-idf/tree/release/v5.5/examples/build_system/cmake/multi_config#create-configuration-profile-files-via-filename