From 3ce9bd995e45ab73ef158eea9aa811924cc9870f Mon Sep 17 00:00:00 2001 From: Roland Dobai Date: Thu, 18 Nov 2021 12:08:06 +0100 Subject: [PATCH] Docs: Add migration guide for Windows environment (Msys/Mingw was removed) --- docs/en/migration-guides/index.rst | 1 + docs/en/migration-guides/windows-env.rst | 4 ++++ docs/zh_CN/migration-guides/index.rst | 1 + docs/zh_CN/migration-guides/windows-env.rst | 1 + 4 files changed, 7 insertions(+) create mode 100644 docs/en/migration-guides/windows-env.rst create mode 100644 docs/zh_CN/migration-guides/windows-env.rst diff --git a/docs/en/migration-guides/index.rst b/docs/en/migration-guides/index.rst index 783e0184ff..fe4c6c7a5e 100644 --- a/docs/en/migration-guides/index.rst +++ b/docs/en/migration-guides/index.rst @@ -5,6 +5,7 @@ ESP-IDF 5.0 Migration Guides .. toctree:: :maxdepth: 1 + Environment Setup on Windows Peripherals Build System System diff --git a/docs/en/migration-guides/windows-env.rst b/docs/en/migration-guides/windows-env.rst new file mode 100644 index 0000000000..aace8713c0 --- /dev/null +++ b/docs/en/migration-guides/windows-env.rst @@ -0,0 +1,4 @@ +Migrate Windows Environment to ESP-IDF 5.0 +========================================== + +The Msys/Mingw-based Windows environment support got deprecated in ESP-IDF v4.0 and was entirely removed in v5.0. Please use :ref:`get-started-windows-tools-installer` to set up a compatible environment. The options include Windows Command Line, Power Shell and the graphical user interface based on Eclipse IDE. In addition, a VS Code-based environment can be set up with the supported plugin: https://github.com/espressif/vscode-esp-idf-extension. diff --git a/docs/zh_CN/migration-guides/index.rst b/docs/zh_CN/migration-guides/index.rst index d4fa90df37..8a937d22a1 100644 --- a/docs/zh_CN/migration-guides/index.rst +++ b/docs/zh_CN/migration-guides/index.rst @@ -5,6 +5,7 @@ ESP-IDF 5.0 迁移指南 .. toctree:: :maxdepth: 1 + Environment Setup on Windows 外设 构建系统 系统 diff --git a/docs/zh_CN/migration-guides/windows-env.rst b/docs/zh_CN/migration-guides/windows-env.rst new file mode 100644 index 0000000000..fc59b9cb8a --- /dev/null +++ b/docs/zh_CN/migration-guides/windows-env.rst @@ -0,0 +1 @@ +.. include:: ../../en/migration-guides/windows-env.rst