Skip to content

Commit e624a3d

Browse files
committed
doc: gsg: Installing OpenOCD with Chocolatey on Windows environment
Chocolatey distributes OpenOCD, which we can use in Windows environments. Using this, we can include the installation of OpenOCD to the GSG procedure also on Windows. The GSG procedure has included installing OpenOCD on Linux/macOS so that we can align things on a level with this. I added "openocd" to the `choco install` command-line and fit related descriptions. Signed-off-by: TOKITA Hiroshi <[email protected]>
1 parent 8c705ca commit e624a3d

File tree

2 files changed

+4
-6
lines changed

2 files changed

+4
-6
lines changed

doc/develop/flash_debug/host-tools.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -324,12 +324,10 @@ Check if your SoC is listed in `OpenOCD Supported Devices`_.
324324

325325
.. note:: On Linux, openocd is available though the `Zephyr SDK
326326
<https://github.com/zephyrproject-rtos/sdk-ng/releases>`_.
327-
Windows users should use the following steps to install
328-
openocd:
327+
To install OpenOCD on Windows, run ``choco install openocd`` as an Administrator.
328+
On macOS, run ``brew install openocd``.
329329

330-
- Download openocd for Windows from here: `OpenOCD Windows`_
331-
- Copy bin and share dirs to ``C:\Program Files\OpenOCD\``
332-
- Add ``C:\Program Files\OpenOCD\bin`` to 'PATH' environment variable
330+
If you did instructions of :ref:`install-required-tools`, OpenOCD is already installed.
333331

334332
.. _pyocd-debug-host-tools:
335333

doc/develop/getting_started/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ The current minimum required version for the main dependencies are:
185185
.. code-block:: bat
186186
187187
choco install cmake --installargs 'ADD_CMAKE_TO_PATH=System'
188-
choco install ninja gperf python311 git dtc-msys2 wget 7zip
188+
choco install ninja gperf python311 git dtc-msys2 wget 7zip openocd
189189
190190
.. warning::
191191

0 commit comments

Comments
 (0)