add CN translation for adding python2 deprecation warning(MR 11115)

2020-11-30 20:11:36 +08:00
parent d0d7c53ee1
commit 81eb9f280f
8 changed files with 151 additions and 23 deletions
--- a/docs/en/get-started/macos-setup.rst
+++ b/docs/en/get-started/macos-setup.rst
@@ -37,7 +37,7 @@ ESP-IDF will use the version of Python installed by default on macOS.
 Installing and setting up Python 3 as default
 ---------------------------------------------

-Basing on macOS `Catalina 10.15 release notes`_, use of Python 2.7 is not recommended and Python will not be included by default in future versions of macOS. Check what Python you currently have::
+Basing on macOS `Catalina 10.15 release notes`_, use of Python 2.7 is not recommended and Python 2.7 will not be included by default in future versions of macOS. Check what Python you currently have::

  python --version

@@ -54,7 +54,7 @@ Below is an overview of steps to install Python 3 and making it default interpre
      brew install python3
      ln -s /usr/local/bin/python3.8 /usr/local/bin/python

-    Adjust above directory name ``/usr/local/bin/python3.8`` to point where Python 3 has been installed. To check this directory you can run  ``which -a python``.
+    Adjust above directory name ``/usr/local/bin/python3.8`` to point where Python 3 has been installed. To check this directory you can run  ``which -a python3``.

  - If you have MacPorts_, you can run::

@@ -77,6 +77,7 @@ Python 2 deprecation

 Python 2 reached its `end of life <https://www.python.org/doc/sunset-python-2/>`_ and support for it in ESP-IDF will be removed soon. Please install Python 3.6 or higher. Instructions for macOS are listed above.

+
 Next Steps
 ==========

--- a/docs/zh_CN/get-started/linux-setup-scratch.rst
+++ b/docs/zh_CN/get-started/linux-setup-scratch.rst
@@ -6,6 +6,8 @@

 除了从乐鑫官网直接下载已编译好的二进制工具链外，您还可以按照本文介绍，从头开始设置自己的工具链。如需快速使用已编译好的二进制工具链，可回到 :doc:`linux-setup` 章节。

+.. 注解:: 设置自己的工具链可以解决 Y2K38 问题（time_t 从 32 位扩展到 64 位）。
+
 安装准备
 =====================

@@ -13,18 +15,20 @@

 - CentOS 7::

-    sudo yum install git wget ncurses-devel flex bison gperf python pyserial python-pyelftools 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
+
+目前仍然支持 CentOS 7，但为了更好的用户体验，建议使用 CentOS 8。

 - Ubuntu 和 Debian::

-    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 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

 - Arch::

-    sudo pacman -S --needed gcc git make ncurses flex bison gperf python-pyserial python-click 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

-.. note::
-    使用 ESP-IDF 需要 CMake 3.5 或以上版本。较早版本的 Linux 可能需要升级才能向后移植仓库，或安装 "cmake3" 软件包，而不是安装 "cmake"。
+.. 注解::
+    使用 ESP-IDF 需要 CMake 3.5 或以上版本。较早的 Linux 发行版可能需要升级自身的软件源仓库，或开启 backports 套件库，或安装 "cmake3" 软件包（不是安装 "cmake")。

 从源代码编译工具链
 =================================
@@ -33,7 +37,7 @@

 - CentOS 7::

-    sudo yum install gawk gperf grep gettext ncurses-devel python python-devel automake bison flex texinfo help2man libtool make
+    sudo yum install gawk gperf grep gettext ncurses-devel python3 python3-devel automake bison flex texinfo help2man libtool make

 - Ubuntu pre-16.04::

@@ -49,7 +53,7 @@

 - Arch::

-    TODO
+    sudo pacman -Sy --needed python-pip

 创建工作目录，并进入该目录::

@@ -60,19 +64,49 @@

 .. include-build-file:: inc/scratch-build-code.inc

+.. 注解:: 在设置支持 64 位 time_t 的工具链时，您需要将 ``crosstool-NG/samples/xtensa-esp32-elf/crosstool.config`` 文件中第 33 和 43 行的可选参数 ``--enable-newlib-long-time_t`` 删除。 
+
 编译工具链::

    ./ct-ng xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf
    ./ct-ng build
    chmod -R u+w builds/xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf

-.. only:: esp32
+编译得到的工具链会被保存至 ``~/esp/crosstool-NG/builds/xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf``。

-    编译得到的工具链会被保存到 ``~/esp/crosstool-NG/builds/xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf``。请按照 :ref:`标准设置指南 <setup-linux-toolchain-add-it-to-path-legacy>` 的介绍，将工具链添加到 ``PATH``。
+
+添加工具链到 PATH 环境变量
+===========================
+
+需要将自定义工具链复制到一个二进制目录中，并将其添加到 ``PATH`` 中。例如，您可以将编译好的工具链复制到 ``~/esp/xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf/`` 目录中。
+
+为了正常使用工具链，您需要更新 ``~/.profile`` 文件中 ``PATH`` 环境变量。此外，您还可以在 ``~/.profile`` 文件中增加以下代码。这样，所有终端窗口均可以使用 ``xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf``::
+
+    export PATH="$HOME/esp/xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf/bin:$PATH"
+
+.. 注解::
+    
+    如果您已将 ``/bin/bash`` 设置为登录 shell，且同时存在 ``.bash_profile`` 和 ``.profile`` 两个文件，则请更新 ``.bash_profile``。在 CentOS 环境下, ``alias`` 需要添加到 ``.bashrc`` 文件中。
+
+退出并重新登录以使 ``.profile`` 的更改生效。运行以下命令来检查 ``PATH`` 设置是否正确::
+
+    printenv PATH
+
+此时您需要检查输出结果的开头中是否包含类似如下的工具链路径::
+
+    $ printenv PATH
+    /home/user-name/esp/xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf/bin:/home/user-name/bin:/home/user-name/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin
+
+注意这里的 ``/home/user-name`` 应该替换成您安装的主路径。
+
+
+停用 Python 2 
+====================
+
+Python 2 已经 `结束生命周期 <https://www.python.org/doc/sunset-python-2/>`_，ESP-IDF 很快将不再支持 Python 2。请安装 Python 3.6 或以上版本。可参考上面列出的目前主流 Linux 发行版的安装说明。


 后续步骤
 ==========

-继续设置开发环境，请前往 :ref:`get-started-get-esp-idf` 章节。
-
+继续设置开发环境，请前往 :ref:`get-started-get-esp-idf` 章节。
--- a/docs/zh_CN/get-started/linux-setup.rst
+++ b/docs/zh_CN/get-started/linux-setup.rst
@@ -11,11 +11,13 @@ Linux 平台工具链的标准设置

 - CentOS 7::

-    sudo yum install git wget flex bison gperf python 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
+
+目前仍然支持 CentOS 7，但为了更好的用户体验，建议使用 CentOS 8。

 - Ubuntu 和 Debian::

-    sudo apt-get install git wget flex bison gperf python python-pip python-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

 - Arch::

@@ -30,7 +32,47 @@ Linux 平台工具链的标准设置
 权限问题 /dev/ttyUSB0
 ------------------------------------------------------------

-使用某些 Linux 版本向 {IDF_TARGET_NAME} 烧写固件时，可能会出现 ``Failed to open port /dev/ttyUSB0`` 错误消息。此时，可以将当前用户增加至 :ref:` Linux Dialout 组 <linux-dialout-group>`。
+使用某些 Linux 版本向 {IDF_TARGET_NAME} 烧录固件时，可能会出现 ``Failed to open port /dev/ttyUSB0`` 错误消息。此时可以将用户添加至 :ref:`Linux Dialout 组<linux-dialout-group>`。
+
+设置 Python 3 为 CentOS 默认 Python 版本
+----------------------------------------------------
+
+CentOS 7 及更早的版本提供 Python 2.7 作为默认解释器。但这里推荐使用 Python 3，您可以运行下方命令安装 Python 3。或者查看当前所用系统的相关文档，按照文档推荐的其它方法安装 Python 3::
+
+    sudo yum -y update && sudo yum install python3 python3-pip python3-setuptools
+
+设置 Python 3 为默认 Python 版本::
+
+    sudo update-alternatives --install /usr/bin/python python /usr/bin/python3 10 && alias pip=pip3
+
+
+设置 Python 3 为 Ubuntu 和 Debian 默认 Python 版本
+----------------------------------------------------
+
+Ubuntu（v18.04 及之前的版本）和 Debian（v9 及之前的版本）的默认解释器为 Python 2.7，但这里推荐使用 Python 3，您可以运行下方命令安装 Python 3。或者查看当前所用系统的相关文档，按照文档推荐的其它方法安装 Python 3::
+
+    sudo apt-get install python3 python3-pip python3-setuptools
+
+设置 Python 3 为默认 Python 版本::
+
+    sudo update-alternatives --install /usr/bin/python python /usr/bin/python3 10 && alias pip=pip3
+
+.. 注解::
+    上述设置为全局设置，同时会影响到其它应用。
+
+修复 Ubuntu 16.04 损坏的 pip 
+=================================
+
+``python3-pip`` 包可能已损坏无法升级。需使用脚本 `get-pip.py <https://bootstrap.pypa.io/get-pip.py>`_ 手动删除并安装该包::
+
+    apt remove python3-pip python3-virtualenv; rm -r ~/.local
+    rm -r ~/.espressif/python_env && python get-pip.py
+
+停用 Python 2 
+====================
+
+Python 2 已经 `结束生命周期 <https://www.python.org/doc/sunset-python-2/>`_，ESP-IDF 很快将不再支持 Python 2。请安装 Python 3.6 或以上版本。可参考上面列出的目前主流 Linux 发行版的安装说明。
+

 后续步骤
 ==========
--- a/docs/zh_CN/get-started/macos-setup-scratch.rst
+++ b/docs/zh_CN/get-started/macos-setup-scratch.rst
@@ -1,5 +1,5 @@
 ***********************************************
-从零开始设置 MacOS 环境下的工具链
+从零开始设置 macOS 环境下的工具链
 ***********************************************

 :link_to_translation:`en:[English]`
@@ -80,6 +80,12 @@ MacPorts 需要完整的 XCode 软件，而 homebrew 只需要安装 XCode 命
 编译得到的工具链会被保存到 ``~/esp/ctng-volume/crosstool-NG/builds/xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf``。使用工具链前，请将 ``~/esp/ctng-volume/crosstool-NG/builds/xtensa-{IDF_TARGET_TOOLCHAIN_NAME}-elf/bin`` 添加至 ``PATH`` 环境变量。


+停用 Python 2 
+====================
+
+Python 2 已经 `结束生命周期 <https://www.python.org/doc/sunset-python-2/>`_，ESP-IDF 很快将不再支持 Python 2。请安装 Python 3.6 或以上版本。可参考上面列出的 macOS 安装说明。
+
+
 后续步骤
 ==========

--- a/docs/zh_CN/get-started/macos-setup.rst
+++ b/docs/zh_CN/get-started/macos-setup.rst
@@ -35,6 +35,50 @@ ESP-IDF 将使用 Mac OS 上默认安装的 Python 版本。

    则必须安装 XCode 命令行工具，具体可运行 ``xcode-select --install``。

+安装并设置 Python 3 为默认版本
+---------------------------------------------
+
+`Catalina 10.15 发布说明`_ 中表示不推荐使用 Python 2.7 版本，在未来的 macOS 版本中也不会默认包含 Python 2.7。执行以下命令来检查您当前使用的 Python 版本::
+
+  python --version
+
+如果输出结果是 ``Python 2.7.17``，则代表您的默认解析器是 Python 2.7。这时需要您运行以下命令检查电脑上是否已经安装过 Python 3::
+
+  python3 --version
+
+如果运行上述命令出现错误，则代表电脑上没有安装 Python 3。
+
+请根据以下步骤安装 Python 3 并使其成为默认解释器：
+
+  - 使用 HomeBrew_ 进行安装的方法如下::
+
+      brew install python3
+      ln -s /usr/local/bin/python3.8 /usr/local/bin/python
+
+    将上述的目录名 ``/usr/local/bin/python3.8`` 修改为 Python 3 所在的目录。您可以运行 ``which -a python3`` 来查看 Python 3 所在的目录。
+
+  - 使用 MacPorts_ 进行安装的方法如下::
+
+      sudo port install python38
+      sudo port select --set python python38
+
+现在您可以打开终端窗口验证默认运行的 Python 版本::
+
+  python --version
+
+如果输出结果类似于 ``Python 3.8.5`` 则代表安装成功。
+
+.. 注解::
+
+    上述设置为全局设置，同时会影响到其它应用。
+
+
+
+停用 Python 2 
+====================
+
+Python 2 已经 `结束生命周期 <https://www.python.org/doc/sunset-python-2/>`_，ESP-IDF 很快将不再支持 Python 2。请安装 Python 3.6 或以上版本。可参考上面列出的 macOS 安装说明。
+
 后续步骤
 ==========

@@ -46,4 +90,4 @@ ESP-IDF 将使用 Mac OS 上默认安装的 Python 版本。
 .. _ccache: https://ccache.samba.org/
 .. _homebrew: https://brew.sh/
 .. _MacPorts: https://www.macports.org/install.php
-
+.. _Catalina 10.15 发布说明: https://developer.apple.com/documentation/macos-release-notes/macos-catalina-10_15-release-notes
--- a/tools/ci/check_build_warnings.py
+++ b/tools/ci/check_build_warnings.py
@@ -30,7 +30,8 @@ IGNORE_WARNS = [
        r"changes choice state",
        r"crosstool_version_check\.cmake",
        r"CryptographyDeprecationWarning",
-        r"Python 3 versions older than 3.6 are not supported."
+        r"Python 3 versions older than 3.6 are not supported.",
+        r"Python 2 is deprecated and will be removed in future versions."
    ]
 ]

--- a/tools/ci/config/build.yml
+++ b/tools/ci/config/build.yml
@@ -79,6 +79,8 @@ build_esp_idf_tests_cmake_esp32s2:

 .build_examples_template:
  extends: .build_template
+  variables:
+      PYTHON_VER: 3
  parallel: 9
  artifacts:
    when: always
@@ -91,8 +93,6 @@ build_esp_idf_tests_cmake_esp32s2:
      - $BOT_LABEL_EXAMPLE_TEST
      - $BOT_LABEL_REGULAR_TEST
      - $BOT_LABEL_WEEKEND_TEST
-      - PYTHON_VER: 3
-
  script:
    # it's not possible to build 100% out-of-tree and have the "artifacts"
    # mechanism work, but this is the next best thing
--- a/tools/idf.py
+++ b/tools/idf.py
@@ -84,9 +84,9 @@ def check_environment():

    # check Python version
    if sys.version_info[0] < 3:
-        print_warning("WARNING: Support for Python 2 is deprecated and will be removed in future versions.")
+        print("WARNING: Support for Python 2 is deprecated and will be removed in future versions.")
    elif sys.version_info[0] == 3 and sys.version_info[1] < 6:
-        print_warning("WARNING: Python 3 versions older than 3.6 are not supported.")
+        print("WARNING: Python 3 versions older than 3.6 are not supported.")

    # check Python dependencies
    checks_output.append("Checking Python dependencies...")