Skip to content

Commit

Permalink
doc: Add libusb package dependencies for Arch, CentOS
Browse files Browse the repository at this point in the history
- Arch uses 'libusb' package, provides libusb-1.0.so
- CentOS has moved to 'libusbx', which is libusb-1 API compatible

Related to #4095
  • Loading branch information
projectgus authored and espressif-bot committed Jan 13, 2021
1 parent f12544a commit e2910d2
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions docs/en/get-started/linux-setup-scratch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To compile with ESP-IDF you need to get the following packages:

- CentOS 7::

sudo yum -y update && sudo yum install git wget ncurses-devel flex bison gperf python3 python3-pip cmake ninja-build ccache dfu-util
sudo yum -y update && sudo yum install git wget ncurses-devel flex bison gperf python3 python3-pip cmake ninja-build ccache dfu-util libusbx

CentOS 7 is still supported but CentOS version 8 is recommended for a better user experience.

Expand All @@ -25,7 +25,7 @@ CentOS 7 is still supported but CentOS version 8 is recommended for a better use

- Arch::

sudo pacman -Sy --needed gcc git make ncurses flex bison gperf python-pyserial python-cryptography python-future python-pyparsing python-pyelftools cmake ninja ccache dfu-util
sudo pacman -Sy --needed gcc git make ncurses flex bison gperf python-pyserial python-cryptography python-future python-pyparsing python-pyelftools cmake ninja ccache dfu-util libusb

.. 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".
Expand Down
4 changes: 2 additions & 2 deletions docs/en/get-started/linux-setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ To compile with ESP-IDF you need to get the following packages:

- CentOS 7::

sudo yum -y update && sudo yum install git wget flex bison gperf python3 cmake ninja-build ccache dfu-util
sudo yum -y update && sudo yum install git wget flex bison gperf python3 cmake ninja-build ccache dfu-util libusbx

CentOS 7 is still supported but CentOS version 8 is recommended for a better user experience.

Expand All @@ -21,7 +21,7 @@ CentOS 7 is still supported but CentOS version 8 is recommended for a better use

- Arch::

sudo pacman -S --needed gcc git make flex bison gperf python-pip cmake ninja ccache dfu-util
sudo pacman -S --needed gcc git make flex bison gperf python-pip cmake ninja ccache dfu-util libusb

.. 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".
Expand Down
6 changes: 3 additions & 3 deletions docs/zh_CN/get-started/linux-setup-scratch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,17 @@

- CentOS 7::

sudo yum -y update && sudo yum install git wget ncurses-devel flex bison gperf python3 python3-pip cmake ninja-build ccache dfu-util
sudo yum -y update && sudo yum install git wget ncurses-devel flex bison gperf python3 python3-pip cmake ninja-build ccache dfu-util libusbx

目前仍然支持 CentOS 7,但为了更好的用户体验,建议使用 CentOS 8。

- Ubuntu 和 Debian::

sudo apt-get install git wget libncurses-dev flex bison gperf python3 python3-pip python3-setuptools python3-serial python3-cryptography python3-future python3-pyparsing python3-pyelftools cmake ninja-build ccache libffi-dev libssl-dev dfu-util
sudo apt-get install git wget libncurses-dev flex bison gperf python3 python3-pip python3-setuptools python3-serial python3-cryptography python3-future python3-pyparsing python3-pyelftools cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0

- Arch::

sudo pacman -Sy --needed gcc git make ncurses flex bison gperf python-pyserial python-cryptography python-future python-pyparsing python-pyelftools cmake ninja ccache dfu-util
sudo pacman -Sy --needed gcc git make ncurses flex bison gperf python-pyserial python-cryptography python-future python-pyparsing python-pyelftools cmake ninja ccache dfu-util libusb

.. 注解::

Expand Down
8 changes: 4 additions & 4 deletions docs/zh_CN/get-started/linux-setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@ Linux 平台工具链的标准设置

- CentOS 7::

sudo yum -y update && sudo yum install git wget flex bison gperf python3 cmake ninja-build ccache dfu-util
sudo yum -y update && sudo yum install git wget flex bison gperf python3 cmake ninja-build ccache dfu-util libusbx

目前仍然支持 CentOS 7,但为了更好的用户体验,建议使用 CentOS 8。

- Ubuntu 和 Debian::

sudo apt-get install git wget flex bison gperf python3 python3-pip python3-setuptools cmake ninja-build ccache libffi-dev libssl-dev dfu-util
sudo apt-get install git wget flex bison gperf python3 python3-pip python3-setuptools cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0

- Arch::

sudo pacman -S --needed gcc git make flex bison gperf python-pip cmake ninja ccache dfu-util
sudo pacman -S --needed gcc git make flex bison gperf python-pip cmake ninja ccache dfu-util libusb

.. 注解::
使用 ESP-IDF 需要 CMake 3.5 或以上版本。较早的 Linux 发行版可能需要升级自身的软件源仓库,或开启 backports 套件库,或安装 "cmake3" 软件包(不是安装 "cmake")。
Expand Down Expand Up @@ -81,4 +81,4 @@ Python 2 已经 `结束生命周期 <https://www.python.org/doc/sunset-python-2/
继续设置开发环境,请前往 :ref:`get-started-get-esp-idf` 章节。


.. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository
.. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository

0 comments on commit e2910d2

Please sign in to comment.