Merge branch 'feature/docs_for_updated_idf_argparsing' into 'master'

docs: Update order of arguments for idf.py and add click linux package

Closes IDF-501

See merge request idf/esp-idf!5166
This commit is contained in:
Angus Gratton
2019-06-21 11:42:59 +08:00
6 changed files with 18 additions and 18 deletions

View File

@@ -130,13 +130,13 @@ Change into tools/unit-test-app directory to configure and build it:
* `idf.py menuconfig` - configure unit test app. * `idf.py menuconfig` - configure unit test app.
* `idf.py build -T all` - build unit test app with tests for each component having tests in the ``test`` subdirectory. * `idf.py -T all build` - build unit test app with tests for each component having tests in the ``test`` subdirectory.
* `idf.py build -T xxx` - build unit test app with tests for specific components. * `idf.py -T xxx build` - build unit test app with tests for specific components.
* `idf.py build -T all -E xxx` - build unit test app with all unit tests, except for unit tests of some components. (For instance: `idf.py build -T all -E ulp mbedtls` - build all unit tests exludes ulp and mbedtls components). * `idf.py -T all -E xxx build` - build unit test app with all unit tests, except for unit tests of some components. (For instance: `idf.py -T all -E ulp -E mbedtls build` - build all unit tests exludes ulp and mbedtls components).
When the build finishes, it will print instructions for flashing the chip. You can simply run ``idf.py flash`` to flash all build output. When the build finishes, it will print instructions for flashing the chip. You can simply run ``idf.py flash`` to flash all build output.
You can also run ``idf.py flash -T all`` or ``idf.py flash -T xxx`` to build and flash. Everything needed will be rebuilt automatically before flashing. You can also run ``idf.py -T all flash`` or ``idf.py -T xxx flash`` to build and flash. Everything needed will be rebuilt automatically before flashing.
Use menuconfig to set the serial port for flashing. Use menuconfig to set the serial port for flashing.

View File

@@ -19,11 +19,11 @@ To compile with ESP-IDF you need to get the following packages:
- Ubuntu and Debian:: - Ubuntu and Debian::
sudo apt-get install git wget libncurses-dev flex bison gperf python python-pip python-setuptools python-serial python-cryptography python-future python-pyparsing python-pyelftools cmake ninja-build ccache sudo apt-get install git wget libncurses-dev flex bison gperf python python-pip python-setuptools python-serial python-click python-cryptography python-future python-pyparsing python-pyelftools cmake ninja-build ccache
- Arch:: - Arch::
sudo pacman -S --needed gcc git make ncurses flex bison gperf python2-pyserial python2-cryptography python2-future python2-pyparsing python2-pyelftools cmake ninja ccache sudo pacman -S --needed gcc git make ncurses flex bison gperf python2-pyserial python2-click python2-cryptography python2-future python2-pyparsing python2-pyelftools cmake ninja ccache
.. note:: .. note::
CMake version 3.5 or newer is required for use with ESP-IDF. Older Linux distributions may require updating, enabling of a "backports" repository, or installing of a "cmake3" package rather than "cmake". CMake version 3.5 or newer is required for use with ESP-IDF. Older Linux distributions may require updating, enabling of a "backports" repository, or installing of a "cmake3" package rather than "cmake".

View File

@@ -17,11 +17,11 @@ To compile with ESP-IDF you need to get the following packages:
- Ubuntu and Debian:: - Ubuntu and Debian::
sudo apt-get install git wget libncurses-dev flex bison gperf python python-pip python-setuptools python-serial python-cryptography python-future python-pyparsing python-pyelftools cmake ninja-build ccache sudo apt-get install git wget libncurses-dev flex bison gperf python python-pip python-setuptools python-serial python-click python-cryptography python-future python-pyparsing python-pyelftools cmake ninja-build ccache
- Arch:: - Arch::
sudo pacman -S --needed gcc git make ncurses flex bison gperf python2-pip python2-pyserial python2-cryptography python2-future python2-pyparsing python2-pyelftools cmake ninja ccache sudo pacman -S --needed gcc git make ncurses flex bison gperf python2-pip python2-pyserial python2-click python2-cryptography python2-future python2-pyparsing python2-pyelftools cmake ninja ccache
.. note:: .. note::
CMake version 3.5 or newer is required for use with ESP-IDF. Older Linux distributions may require updating, enabling of a "backports" repository, or installing of a "cmake3" package rather than "cmake". CMake version 3.5 or newer is required for use with ESP-IDF. Older Linux distributions may require updating, enabling of a "backports" repository, or installing of a "cmake3" package rather than "cmake".

View File

@@ -152,21 +152,21 @@ DUT2slave终端
- ``idf.py menuconfig`` - 配置单元测试程序。 - ``idf.py menuconfig`` - 配置单元测试程序。
- ``idf.py build -T all`` - 编译单元测试程序,测试每个组件 ``test`` - ``idf.py -T all build`` - 编译单元测试程序,测试每个组件 ``test``
子目录下的用例。 子目录下的用例。
- ``idf.py build -T xxx`` - 编译单元测试程序,测试指定的组件。 - ``idf.py -T xxx build`` - 编译单元测试程序,测试指定的组件。
- ``idf.py build -T all -E xxx`` - - ``idf.py -T all -E xxx build`` -
编译单元测试程序,测试所有(除开指定)的组件。例如 编译单元测试程序,测试所有(除开指定)的组件。例如
``idf.py build -T all -E ulp mbedtls`` - ``idf.py -T all -E ulp mbedtls build`` -
编译所有的单元测试,不包括 ``ulp````mbedtls``\ 组件。 编译所有的单元测试,不包括 ``ulp````mbedtls``\ 组件。
当编译完成时,它会打印出烧写芯片的指令。您只需要运行 ``idf.py flash`` 当编译完成时,它会打印出烧写芯片的指令。您只需要运行 ``idf.py flash``
即可烧写所有编译输出的文件。 即可烧写所有编译输出的文件。
您还可以运行 ``idf.py flash -T all`` 或者 您还可以运行 ``idf.py -T all flash`` 或者
``idf.py flash -T xxx`` ``idf.py -T xxx flash``
来编译并烧写,所有需要的文件都会在烧写之前自动重新编译。 来编译并烧写,所有需要的文件都会在烧写之前自动重新编译。
使用 ``menuconfig`` 可以设置烧写测试程序所使用的串口。 使用 ``menuconfig`` 可以设置烧写测试程序所使用的串口。

View File

@@ -19,11 +19,11 @@
- Ubuntu 和 Debian:: - Ubuntu 和 Debian::
sudo apt-get install git wget libncurses-dev flex bison gperf python python-pip python-setuptools python-serial python-cryptography python-future python-pyparsing python-pyelftools cmake ninja-build ccache sudo apt-get install git wget libncurses-dev flex bison gperf python python-pip python-setuptools python-serial python-click python-cryptography python-future python-pyparsing python-pyelftools cmake ninja-build ccache
- Arch:: - Arch::
sudo pacman -S --needed gcc git make ncurses flex bison gperf python2-pyserial python2-cryptography python2-future python2-pyparsing python2-pyelftools cmake ninja ccache sudo pacman -S --needed gcc git make ncurses flex bison gperf python2-pyserial python2-click python2-cryptography python2-future python2-pyparsing python2-pyelftools cmake ninja ccache
.. note:: .. note::

View File

@@ -17,11 +17,11 @@ Linux 平台工具链的标准设置 (CMake)
- Ubuntu 和 Debian:: - Ubuntu 和 Debian::
sudo apt-get install git wget libncurses-dev flex bison gperf python python-pip python-setuptools python-serial python-cryptography python-future python-pyparsing python-pyelftools cmake ninja-build ccache sudo apt-get install git wget libncurses-dev flex bison gperf python python-pip python-setuptools python-serial python-click python-cryptography python-future python-pyparsing python-pyelftools cmake ninja-build ccache
- Arch:: - Arch::
sudo pacman -S --needed gcc git make ncurses flex bison gperf python2-pyserial python2-cryptography python2-future python2-pyparsing python2-pyelftools cmake ninja ccache sudo pacman -S --needed gcc git make ncurses flex bison gperf python2-pyserial python2-click python2-cryptography python2-future python2-pyparsing python2-pyelftools cmake ninja ccache
.. note:: .. note::
使用 ESP-IDF 需要 CMake 3.5 或以上版本。较早版本的 Linux 可能需要升级才能向后移植仓库,或安装 "cmake3" 软件包,而不是安装 "cmake"。 使用 ESP-IDF 需要 CMake 3.5 或以上版本。较早版本的 Linux 可能需要升级才能向后移植仓库,或安装 "cmake3" 软件包,而不是安装 "cmake"。