Skip to content

Rationalise debugprobe setup #4109

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

Jump to bottom
Merged
merged 2 commits into from
May 21, 2025
Merged

Rationalise debugprobe setup #4109

merged 2 commits into from
May 21, 2025

Conversation

P33M
Copy link
Contributor

@P33M P33M commented May 20, 2025

There's little point in duplicating instructions. I strongly prefer a single source of truth wherever possible, and a monolithic setup guide is better.

There's more to be done in the PDFs that link back to the documentation website (they shouldn't), but the website should at least call out the right chapters...

@lurch
Copy link
Contributor

lurch commented May 20, 2025 •
edited
Loading

On the whole, LGTM. I guess this addresses some of the concerns raised in #4003

I strongly prefer a single source of truth wherever possible

Ditto 😍

@P33M P33M force-pushed the openocd_rationalise branch from 6b85829 to 8a9ba5d Compare May 20, 2025 13:58
P33M added 2 commits May 20, 2025 15:28
@P33M
Debug probe: installation instruction improvements
2ba070c 
Users should be steered to VSCode as that provides the fewest
opportunities to get something wrong.

Remove obsolete pico-setup-windows reference, along with broken
references to parts of the Pico guide.
@P33M
debug probe: describe standalone sessions better
915f45f 
Promote the VScode extension first.
@P33M P33M force-pushed the openocd_rationalise branch from 8a9ba5d to 915f45f Compare May 20, 2025 14:28
@lurch
Copy link
Contributor

lurch commented May 20, 2025

I know that it might not be within the original scope of the current PR, but I just spotted that the openocd commands on this page are using target/rp2040.cfg. Perhaps it's also worth sneaking in a mention that you'd need to use target/rp2350.cfg if you're using a Pico 2 ?

@P33M
Copy link
Contributor Author

P33M commented May 20, 2025

I know that it might not be within the original scope of the current PR, but

It's not within the scope of this PR. I'm not doing wholesale rearchitecting.
The config files (and options) mutate between downstream openocd and upstream and are out of scope here.

@lurch
Copy link
Contributor

lurch commented May 21, 2025

It's not within the scope of this PR. I'm not doing wholesale rearchitecting.

Fair enough.

The config files (and options) mutate between downstream openocd and upstream and are out of scope here.

Perhaps in a future PR it might be worth also removing the example openocd commands in the HTML documentation, and again refer the user to the getting-started PDF?

@JamesH65
Copy link
Contributor

Best to add an issue so the extra work is not forgotten when the new docs person arrives.

@lurch lurch merged commit 416e209 into raspberrypi:develop May 21, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lurch lurch lurch approved these changes

+1 more reviewer

@will-v-pi will-v-pi will-v-pi left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@P33M @lurch @JamesH65 @will-v-pi