From 987631b9a0db8eedfb7d2c9de8006e7c32e0c394 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Thu, 30 Mar 2017 10:58:58 +1100 Subject: [PATCH 1/2] windows: Don't expand PATH when generating setup Ref #467 https://github.com/espressif/esp-idf/issues/467 --- docs/windows-setup.rst | 2 +- tools/windows/windows_install_prerequisites.sh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/windows-setup.rst b/docs/windows-setup.rst index 16b46732a7..9c90d9183b 100644 --- a/docs/windows-setup.rst +++ b/docs/windows-setup.rst @@ -8,7 +8,7 @@ Windows doesn't have a built-in "make" environment, so as well as installing the The quick setup is to download the Windows all-in-one toolchain & MSYS zip file from dl.espressif.com: -https://dl.espressif.com/dl/esp32_win32_msys2_environment_and_toolchain-20170321.zip +https://dl.espressif.com/dl/esp32_win32_msys2_environment_and_toolchain-20170330.zip Unzip the zip file to ``C:\`` (or some other location, but this guide assumes ``C:\``) and it will create an "msys32" directory with a pre-prepared environment. diff --git a/tools/windows/windows_install_prerequisites.sh b/tools/windows/windows_install_prerequisites.sh index 1b3f39059c..b4d6337682 100644 --- a/tools/windows/windows_install_prerequisites.sh +++ b/tools/windows/windows_install_prerequisites.sh @@ -51,7 +51,7 @@ rm ~/${TOOLCHAIN_ZIP} cat > /etc/profile.d/esp32_toolchain.sh << EOF # This file was created by ESP-IDF windows_install_prerequisites.sh # and will be overwritten if that script is run again. -export PATH="$PATH:/opt/xtensa-esp32-elf/bin" +export PATH="\$PATH:/opt/xtensa-esp32-elf/bin" EOF # clean up pacman packages to save some disk space From c0fb62531e34aace1afd7491a9a6ad5713aba934 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Thu, 30 Mar 2017 11:29:03 +1100 Subject: [PATCH 2/2] doc: Fix some Windows Setup Guide links --- docs/windows-setup-scratch.rst | 2 ++ docs/windows-setup.rst | 6 ++---- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/windows-setup-scratch.rst b/docs/windows-setup-scratch.rst index 2037a21da6..07cd51ecdd 100644 --- a/docs/windows-setup-scratch.rst +++ b/docs/windows-setup-scratch.rst @@ -63,3 +63,5 @@ Or with credentials:: export http_proxy='http://user:password@http.proxy.server:PORT' Add this line to ``/etc/profile`` in the MSYS directory in order to permanently enable the proxy when using MSYS. + +.. _MSYS2: https://msys2.github.io/ diff --git a/docs/windows-setup.rst b/docs/windows-setup.rst index 9c90d9183b..6037761687 100644 --- a/docs/windows-setup.rst +++ b/docs/windows-setup.rst @@ -4,7 +4,7 @@ Set up of Toolchain for Windows Step 1: Quick Steps =================== -Windows doesn't have a built-in "make" environment, so as well as installing the toolchain you will need a GNU-compatible environment. We use the MSYS2_ environment to provide this. You don't need to use this environment all the time (you can use Eclipse_ or some other front-end), but it runs behind the scenes. +Windows doesn't have a built-in "make" environment, so as well as installing the toolchain you will need a GNU-compatible environment. We use the MSYS2_ environment to provide this. You don't need to use this environment all the time (you can use :doc:`Eclipse ` or some other front-end), but it runs behind the scenes. The quick setup is to download the Windows all-in-one toolchain & MSYS zip file from dl.espressif.com: @@ -62,10 +62,8 @@ Type a command like this to set the path to ESP-IDF directory: ``export IDF_PATH Use ``cd`` to change to the project directory (not the ESP-IDF directory.) Type ``make menuconfig`` to configure your project, then ``make`` to build it, ``make clean`` to remove built files, and ``make flash`` to flash (use the menuconfig to set the serial port for flashing.) -If you'd like to use the Eclipse IDE instead of running ``make``, check out the Eclipse setup guide in this directory. +If you'd like to use the Eclipse IDE instead of running ``make``, check out the :doc:`Eclipse guide `. -.. _Eclipse: eclipse-setup.rst -.. _MSYS2: https://msys2.github.io/ .. _github: https://github.com/espressif/esp-idf-template .. _known issue: https://github.com/espressif/esp-idf/issues/11