doc: Documentation issue in 'develop/getting_started/index' OpenOCD

[jsnrauch]

I am not exactly sure if this is an installation dependency, but OpenOCD appears to be a dependency that need to be installed to get through the activities on the first page of the getting started guide. The installation instructions do not even suggest it needs to be installed.

What I am specifically writing about is I follow all the installation steps, install all the dependencies listed. I type "west flash", and was greeted with:

FATAL ERROR: required program openocd not found; install it or add its location to PATH

OpenOCD seems to have great cross platform support, but I cannot find any binary installer for Windows with good installation instructions. It would be nice if the instructions here recommended a specific installation source for Windows and provided supplemental (Open OCD should be better documented) installation instructions as needed to make it easier for customers to use it.

• Page: develop/getting_started/index
• Version: main
• SHA-1: 732785a

[github-actions]

Hi @jsnrauch! We appreciate you submitting your first issue for our open-source project. 🌟

Even though I'm a bot, I can assure you that the whole community is genuinely grateful for your time and effort. 🤖💙

[henrikbrixandersen]

OpenOCD is available via Zephyr SDK host tools. If you did not install those - or if you are not using the Zephyr SDK - you need to install it on your own.

[JarmouniA]

OpenOCD is available via Zephyr SDK host tools.

Only on Linux.

[JarmouniA]

@jsnrauch there are instructions, just not in the Getting Started page
https://docs.zephyrproject.org/latest/develop/flash_debug/host-tools.html#runner-openocd

[JarmouniA]

Related PR #80086

[jsnrauch]

Impressively fast response guys. I appreciate that!

I did install the Zephyr SDK. For Window's that did not appear to install OpenOCD. Based on the comment above, maybe the Zephry SDK for Windows does not include OpenOCD?

If you have to separately install OpenOCD to program and debug projects on Windows, it seems like it is a prerequisite that should be listed with python, cmake, etc.

The issue I had with OpenOCD on Windows is 99% of Window's users are going to use a binary installer. There is not 1 official binary package or installer for Windows. Those are created and maintained by OpenOCD community members, which I greatly appreciate. I struggled with the documentation for the one I tried. Ultimately, I was able to get it going. If the Zephyr community has found one Windows OpenOCD package with good documentation, my thought was to simply point out a specific windows installation solution that should result in the fewest onboarding issues. With that said, I am an open source noob and I got it going. My concern is certainly not a fire.

[henrikbrixandersen]

I did install the Zephyr SDK. For Window's that did not appear to install OpenOCD. Based on the comment above, maybe the Zephry SDK for Windows does not include OpenOCD?

Looks like it. I don't use the Zephyr build system on Windows, so I have no experience with that.

If you have to separately install OpenOCD to program and debug projects on Windows, it seems like it is a prerequisite that should be listed with python, cmake, etc.

While OpenOCD may be needed for your particular board, it is not a generic prerequisite. It's just one of many different flashing backends supported by Zephyr.