]> granicus.if.org Git - esp-idf/commitdiff
doc: Fix some Windows Setup Guide links
authorAngus Gratton <angus@espressif.com>
Thu, 30 Mar 2017 00:29:03 +0000 (11:29 +1100)
committerAngus Gratton <angus@espressif.com>
Thu, 30 Mar 2017 01:09:50 +0000 (12:09 +1100)
docs/windows-setup-scratch.rst
docs/windows-setup.rst

index 2037a21da676ad6a9ed39b74a960daa83cca7014..07cd51ecdd46fc520da2421e656338b7cad05315 100644 (file)
@@ -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/
index 9c90d9183b70e6a94635645657d19760e13fbf98..6037761687e7805768c83d02d5137ea1fd0ece72 100644 (file)
@@ -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 </eclipse-setup>` 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-setup>`.
 
 
-.. _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