Skip to content

doc: gsg: Installing OpenOCD with Chocolatey on Windows environment #80086

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

doc: gsg: Installing OpenOCD with Chocolatey on Windows environment #80086

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions doc/develop/flash_debug/host-tools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,12 +324,10 @@ Check if your SoC is listed in `OpenOCD Supported Devices`_.

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

- Download openocd for Windows from here: `OpenOCD Windows`_
Copy link
Contributor

@JarmouniA JarmouniA Oct 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Chocolatey appears to follow OpenOCD release schedule, which is not ideal to say the least (last one was in 03/2023), whereas gnutoolchains provides more up-to-date builds (20240916). So I think this should be kept.

Copy link
Contributor

@JarmouniA JarmouniA Oct 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Zephyr used to ship OpenOCD in the SDK on Windows (as it is the case on Linux), I don't know why it's no longer the case.

Copy link
Member

@stephanosio stephanosio Oct 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Zephyr used to ship OpenOCD in the SDK on Windows (as it is the case on Linux), I don't know why it's no longer the case.

Host tools were never part of the Windows Zephyr SDK distribution.

We eventually plan to provide the host tools, including OpenOCD, on Windows and macOS; but, that likely will not be anytime soon (mainly because it is not a high priority item).

Copy link
Member Author

@soburi soburi Oct 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for reviewing.
I restored this line.

Copy link
Contributor

@JarmouniA JarmouniA Oct 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@soburi still deleted.

Copy link
Contributor

@JarmouniA JarmouniA Oct 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should be kept as an alternative to Chocolatey for people who want the latest build.
Also, from my experience, Chocolatey is a pain to use on corporate PCs bcz of firewalls/proxy...

- Copy bin and share dirs to ``C:\Program Files\OpenOCD\``
- Add ``C:\Program Files\OpenOCD\bin`` to 'PATH' environment variable
If you did instructions of :ref:`install-required-tools`, OpenOCD is already installed.

.. _pyocd-debug-host-tools:

Expand Down
2 changes: 1 addition & 1 deletion doc/develop/getting_started/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ The current minimum required version for the main dependencies are:
.. code-block:: bat

choco install cmake --installargs 'ADD_CMAKE_TO_PATH=System'
choco install ninja gperf python311 git dtc-msys2 wget 7zip
choco install ninja gperf python311 git dtc-msys2 wget 7zip openocd

.. warning::

Expand Down