Skip to content

Conversation

@crasbe
Copy link
Contributor

@crasbe crasbe commented Oct 14, 2025

Contribution description

While working on #21775, #21776 I noticed that OpenOCD can be a bit of a hassle, so I added some information with the two error messages that cost me a lot of time to the Flashing guide 😅

Testing procedure

Make sure that the guide properly renders and shows the additional information (or look at the screenshot below).
image

Issues/PRs references

Relieve a bit of the pain of #21781 🤣

@crasbe crasbe added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Oct 14, 2025
@github-actions github-actions bot added the Area: doc Area: Documentation label Oct 14, 2025
@crasbe
Copy link
Contributor Author

crasbe commented Oct 14, 2025

TODO: Perhaps I should use the opportunity to add a note that updating the firmware of the ST-Link is always recommended when weird errors occur, as the firmware can be quite old of the devices shipped.

@crasbe crasbe added the State: WIP State: The PR is still work-in-progress and its code is not in its final presentable form yet label Oct 14, 2025
@riot-ci
Copy link

riot-ci commented Oct 14, 2025

Murdock results

✔️ PASSED

88ff3c6 doc/guides: extend STM32 flash guide

Success Failures Total Runtime
1 0 1 01m:21s

Artifacts

@crasbe
Copy link
Contributor Author

crasbe commented Oct 15, 2025

TODO: Perhaps I should use the opportunity to add a note that updating the firmware of the ST-Link is always recommended when weird errors occur, as the firmware can be quite old of the devices shipped.

Apparently I already did lol.
I moved the information to the top in a "General" section.

@crasbe crasbe removed the State: WIP State: The PR is still work-in-progress and its code is not in its final presentable form yet label Oct 15, 2025
@crasbe crasbe changed the title doc/guides: Extend STM32 Flashing Guide with OpenOCD Remark doc/guides: Extend STM32 Flashing Guide with OpenOCD and WSL Remark Oct 15, 2025
@crasbe crasbe force-pushed the pr/guides_stm32_flash_openocd branch from 3d963b1 to 88ff3c6 Compare October 15, 2025 11:10
@crasbe crasbe enabled auto-merge October 15, 2025 11:10
@crasbe crasbe added this pull request to the merge queue Oct 15, 2025
Merged via the queue into RIOT-OS:master with commit 744d3c0 Oct 15, 2025
26 checks passed
@crasbe crasbe deleted the pr/guides_stm32_flash_openocd branch October 15, 2025 13:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants