forked from espressif/esp-idf
Merge branch 'docs/uninstall_idf' into 'master'
docs(idf-tools): Add uninstallation instructions Closes IDFGH-9768 See merge request espressif/esp-idf!25313
This commit is contained in:
@@ -202,6 +202,24 @@ Custom Installation
|
|||||||
|
|
||||||
Although the methods above are recommended for ESP-IDF users, they are not a must for building ESP-IDF applications. ESP-IDF build system expects that all the necessary tools are installed somewhere, and made available in the ``PATH``.
|
Although the methods above are recommended for ESP-IDF users, they are not a must for building ESP-IDF applications. ESP-IDF build system expects that all the necessary tools are installed somewhere, and made available in the ``PATH``.
|
||||||
|
|
||||||
|
.. _idf-tools-uninstall:
|
||||||
|
|
||||||
|
Uninstall ESP-IDF
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
Uninstalling ESP-IDF requires removing both the tools and the environment variables that have been configured during the installation.
|
||||||
|
|
||||||
|
* Windows users using the :ref:`Windows ESP-IDF Tools Installer <get-started-windows-tools-installer>` can simply run the uninstall wizard to remove ESP-IDF.
|
||||||
|
* To remove an installation performed by running the supported :ref:`install scripts <idf-tools-install>`, simply delete the :ref:`tools installation directory <idf-tools-path>` including the downloaded and installed tools. Any environment variables set by the :ref:`export scripts <idf-tools-export>` are not permanent and will not be present after opening a new environment.
|
||||||
|
* When dealing with a custom installation, in addition to deleting the tools as mentioned above, you may also need to manually revert any changes to environment variables or system paths that were made to accommodate the ESP-IDF tools (e.g., ``IDF_PYTHON_ENV_PATH`` or ``IDF_TOOLS_PATH``). If you manually copied any tools, you would need to track and delete those files manually.
|
||||||
|
* If you installed any plugins like the `ESP-IDF Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README.md>`_ or `VSCode ESP-IDF Extension <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_, you should follow the specific uninstallation instructions described in the documentation of those components.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
Uninstalling the ESP-IDF tools does not remove any project files or your code. Be mindful of what you are deleting to avoid losing any work. If you are unsure about a step, refer back to the installation instructions.
|
||||||
|
|
||||||
|
These instructions assume that the tools were installed following the procedures in this provided document. If you've used a custom installation method, you might need to adapt these instructions accordingly.
|
||||||
|
|
||||||
.. _idf-tools-list:
|
.. _idf-tools-list:
|
||||||
|
|
||||||
List of ESP-IDF Tools
|
List of ESP-IDF Tools
|
||||||
|
@@ -199,3 +199,8 @@ Build Your First Project
|
|||||||
If you already have the ESP-IDF installed and not using IDE, you can build your first project from the command line following the :ref:`Start a Project on Windows <get-started-windows-first-steps>` or :ref:`Start a Project on Linux and macOS <get-started-linux-macos-first-steps>`.
|
If you already have the ESP-IDF installed and not using IDE, you can build your first project from the command line following the :ref:`Start a Project on Windows <get-started-windows-first-steps>` or :ref:`Start a Project on Linux and macOS <get-started-linux-macos-first-steps>`.
|
||||||
|
|
||||||
.. _Stable version: https://docs.espressif.com/projects/esp-idf/en/stable/
|
.. _Stable version: https://docs.espressif.com/projects/esp-idf/en/stable/
|
||||||
|
|
||||||
|
Uninstall ESP-IDF
|
||||||
|
=================
|
||||||
|
|
||||||
|
If you want to remove ESP-IDF, please follow :ref:`idf-tools-uninstall`.
|
||||||
|
@@ -202,6 +202,24 @@ ESP-IDF 的根目录中提供了针对不同 shell 的用户安装脚本,包
|
|||||||
|
|
||||||
推荐用户使用上述方法安装 ESP-IDF 工具,但也可以选择其他方式来构建 ESP-IDF 应用程序。自定义安装时,用户需将所有必要的工具都安装在某个位置,并在 ``PATH`` 中定义,以保证 ESP-IDF 构建系统可用。
|
推荐用户使用上述方法安装 ESP-IDF 工具,但也可以选择其他方式来构建 ESP-IDF 应用程序。自定义安装时,用户需将所有必要的工具都安装在某个位置,并在 ``PATH`` 中定义,以保证 ESP-IDF 构建系统可用。
|
||||||
|
|
||||||
|
.. _idf-tools-uninstall:
|
||||||
|
|
||||||
|
卸载 ESP-IDF
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
卸载 ESP-IDF 需要删除安装过程中配置的工具和环境变量。
|
||||||
|
|
||||||
|
* 使用 :ref:`Windows ESP-IDF 工具安装器 <get-started-windows-tools-installer>` 的 Windows 用户可以直接运行卸载向导卸载 ESP-IDF。
|
||||||
|
* :ref:`工具安装目录 <idf-tools-path>` 下包含了已下载及安装的工具,删除该目录即可删除此前通过运行 :ref:`安装脚本 <idf-tools-install>` 安装的内容。通过 :ref:`导出脚本 <idf-tools-export>` 设置的环境变量不具备永久性,新环境中不会存在此类环境变量。
|
||||||
|
* 如在安装过程中进行了自定义设置,除删除上述工具外,可能还涉及手动恢复此前为适用 ESP-IDF 工具而修改的环境变量及系统路径,例如 ``IDF_PYTHON_ENV_PATH`` 或 ``IDF_TOOLS_PATH``。如存在通过手动复制安装的工具,则也需手动追踪并删除相关文件。
|
||||||
|
* 如安装了 `ESP-IDF Eclipse <https://github.com/espressif/idf-eclipse-plugin/blob/master/README.md>`_ 或 `VSCode ESP-IDF 扩展程序 <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/install.md>`_ 等插件,则需按照对应插件文档中的特定卸载说明进行操作。
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
卸载 ESP-IDF 工具不会删除任何项目文件或用户代码。为防止意外丢失其他文件,请在删除文件时谨慎操作。如果对某个步骤的操作有所疑问,请参考前述安装说明。
|
||||||
|
|
||||||
|
上述卸载指南默认需卸载的工具是按本文档中的步骤进行安装的。如果使用了自定义安装,可能需要进行相应调整。
|
||||||
|
|
||||||
.. _idf-tools-list:
|
.. _idf-tools-list:
|
||||||
|
|
||||||
ESP-IDF 工具列表
|
ESP-IDF 工具列表
|
||||||
|
@@ -199,3 +199,8 @@ IDE
|
|||||||
如果已经安装好 ESP-IDF,且没有使用集成开发环境 (IDE),请在命令提示行中,按照 :ref:`在 Windows 中开始创建工程 <get-started-windows-first-steps>` 或 :ref:`在 Linux 和 macOS 中开始创建工程 <get-started-linux-macos-first-steps>` 编译第一个工程。
|
如果已经安装好 ESP-IDF,且没有使用集成开发环境 (IDE),请在命令提示行中,按照 :ref:`在 Windows 中开始创建工程 <get-started-windows-first-steps>` 或 :ref:`在 Linux 和 macOS 中开始创建工程 <get-started-linux-macos-first-steps>` 编译第一个工程。
|
||||||
|
|
||||||
.. _Stable version: https://docs.espressif.com/projects/esp-idf/en/stable/
|
.. _Stable version: https://docs.espressif.com/projects/esp-idf/en/stable/
|
||||||
|
|
||||||
|
卸载 ESP-IDF
|
||||||
|
=================
|
||||||
|
|
||||||
|
如需卸载 ESP-IDF,请参考 :ref:`idf-tools-uninstall`。
|
||||||
|
Reference in New Issue
Block a user