From bcc5bad7b58052e553dcc79f7446686d2d0bc4bf Mon Sep 17 00:00:00 2001 From: Ivan Grokhotkov Date: Wed, 18 Apr 2018 20:22:48 +0800 Subject: [PATCH] docs: update download links for OpenOCD Point to the latest release on Github, which can now be produced by CI. Ref. https://github.com/espressif/openocd-esp32/issues/30 Ref. https://github.com/espressif/openocd-esp32/issues/18 --- .../jtag-debugging/setup-openocd-linux.rst | 20 ++++++++------- .../jtag-debugging/setup-openocd-macos.rst | 25 ++++++++++++------- .../jtag-debugging/setup-openocd-windows.rst | 21 ++++++++++------ 3 files changed, 40 insertions(+), 26 deletions(-) diff --git a/docs/en/api-guides/jtag-debugging/setup-openocd-linux.rst b/docs/en/api-guides/jtag-debugging/setup-openocd-linux.rst index 434e211eb..a9b8286d9 100644 --- a/docs/en/api-guides/jtag-debugging/setup-openocd-linux.rst +++ b/docs/en/api-guides/jtag-debugging/setup-openocd-linux.rst @@ -1,19 +1,21 @@ -*********************** -Setup OpenOCD for Linux -*********************** +************************ +Set up OpenOCD for Linux +************************ -Setup OpenOCD -============= +Set up OpenOCD +============== -OpenOCD for 64-bit Linux is available for download from Espressif website: +OpenOCD for 64-bit Linux is available for download from Github: -https://dl.espressif.com/dl/openocd-esp32-linux64-a859564.tar.gz +https://github.com/espressif/openocd-esp32/releases -Download this file, then extract it in ``~/esp/`` directory:: +Download latest release archive with `linux64` in its name, for example `openocd-esp32-linux64-0.10.0-esp32-20180418.tar.gz`. + +Extract the downloaded file in ``~/esp/`` directory:: cd ~/esp - tar -xzf ~/Downloads/openocd-esp32-linux64-a859564.tar.gz + tar -xzf ~/Downloads/openocd-esp32-linux64-.tar.gz Next Steps diff --git a/docs/en/api-guides/jtag-debugging/setup-openocd-macos.rst b/docs/en/api-guides/jtag-debugging/setup-openocd-macos.rst index 826667b44..64ecc4eff 100644 --- a/docs/en/api-guides/jtag-debugging/setup-openocd-macos.rst +++ b/docs/en/api-guides/jtag-debugging/setup-openocd-macos.rst @@ -1,19 +1,26 @@ -*********************** -Setup OpenOCD for MacOS -*********************** +************************ +Set up OpenOCD for MacOS +************************ -Setup OpenOCD -============= +Install libusb +============== -OpenOCD for MacOS is available for download from Espressif website: +Use `Homebrew `_ or `Macports `_ to install `libusb` package. -https://dl.espressif.com/dl/openocd-esp32-macos-a859564.tar.gz +Set up OpenOCD +============== -Download this file, then extract it in ``~/esp`` directory:: +OpenOCD for MacOS is available for download from Github: + +https://github.com/espressif/openocd-esp32/releases + +Download latest release archive with `macos` in its name, for example `openocd-esp32-macos-0.10.0-esp32-20180418.tar.gz`. + +Extract the downloaded file in ``~/esp/`` directory:: cd ~/esp - tar -xzf ~/Downloads/openocd-esp32-macos-a859564.tar.gz + tar -xzf ~/Downloads/openocd-esp32-macos-.tar.gz Next Steps diff --git a/docs/en/api-guides/jtag-debugging/setup-openocd-windows.rst b/docs/en/api-guides/jtag-debugging/setup-openocd-windows.rst index 829984d63..12e5560b0 100644 --- a/docs/en/api-guides/jtag-debugging/setup-openocd-windows.rst +++ b/docs/en/api-guides/jtag-debugging/setup-openocd-windows.rst @@ -1,17 +1,22 @@ -************************* -Setup OpenOCD for Windows -************************* +************************** +Set up OpenOCD for Windows +************************** -Setup OpenOCD -============= +Set up OpenOCD +============== -OpenOCD for Windows / MSYS2 is available for download from Espressif website: -https://dl.espressif.com/dl/openocd-esp32-win32-a859564.zip +OpenOCD for Windows / MSYS2 is available for download from Github: -Download this file and extract ``openocd-esp32`` folder inside to ``~/esp/`` directory. +https://github.com/espressif/openocd-esp32/releases +Download latest release archive with `win32` in its name, for example `openocd-esp32-macos-0.10.0-win32-20180418.zip`. + +Extract the downloaded file in ``~/esp/`` directory. + + cd ~/esp + unzip /c/Users//Downloads/openocd-esp32-win32-.zip Next Steps ==========