Enhance documentation for Raspberry Pi debugging setup #1295
Conversation
For people new to the topic, it is not evident that a combination of hardware and software is meant. This changeset adds links to both. Also, I added some words and rephrased a sentence that lacked a verb.
| ### OpenOCD | ||
| Another option is to use Picoprobe and custom version of OpenOCD provided by RPi. | ||
| Another option is to use the [Raspberry Pi Debug Probe](https://www.raspberrypi.com/products/debug-probe/) together with the [Raspberry Pi Picoprobe software](https://github.com/raspberrypi/debugprobe) and a custom version of OpenOCD provided by RPi. |
There was a problem hiding this comment.
As far as I understand, https://github.com/raspberrypi/debugprobe is just the firmware that runs on the Picoprobe hardware, right?
Then I don't think it makes sense to link to it here, because the user does not interact with this software directly.
There was a problem hiding this comment.
Also, I believe that a "custom version" of OpenOCD is no longer necessary since the release of OpenOCD 0.12.0 in February 2023.
The following command works fine on my fedora installation with default openocd package:
openocd -f interface/cmsis-dap.cfg -f target/rp2040.cfgsee https://www.raspberrypi.com/documentation/microcontrollers/debug-probe.html#install-tools
| The how-to shows steps for building and installing the RPi OpenOCD into your | ||
| system globally, however, if you still want to be able to work with other OpenOCD | ||
| binaries, you should only install it locally: | ||
| The how-to explains how to build and install the RPi OpenOCD globally, but if you want to keep using other OpenOCD binaries, you should install it only locally: |
There was a problem hiding this comment.
I would argue to remove the entire following how-to-build-openocd block (which was written in 2022 before the release of OpenOCD 0.12.0) as it is no longer necessary with OpenOCD 0.12.0.
2 participants
For people new to the topic, it is not evident that a combination of hardware and software is meant. This changeset adds links to both.
Also, I added some words and rephrased a sentence that lacked a verb.