-
Couldn't load subscription status.
- Fork 2.1k
boards/nucleo*: Cleanup and Enhance the Documentation #21337
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.
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
Conversation
|
Some of the Nucleo boards have a remark about the toolchain that is to be used: RIOT/boards/nucleo-f303k8/doc.txt Lines 81 to 84 in 48162bd
I wonder if that information is still relevant and should be added to the common files or if it's irrelevant and should be removed. The Launchpad Link is outdated as well: The toolchain is now maintained at Arm: https://developer.arm.com/Tools%20and%20Software/GNU%20Toolchain |
|
In #21794 (comment) I wrote that an OpenOCD update guide doesn't really belong in the guide... RIOT/boards/nucleo-l552ze-q/doc.md Lines 42 to 55 in 744d3c0
Perhaps I should copy that and add it to the guide nevertheless 🤷♂️ Although this case underlines the reason for doing this change: That remark was added in 2020 and OpenOCD 0.11.0 from 2021 already supports that board. Hints like that tend to become quietly outdated unfortunately. |
I think this is the wrong spot. We should rather have a combined OpenOCD guide, but this is beyond the scope of this PR. |
|
Oh heck, that's one gigantic PR |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some typos.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
😵💫 Given the repetitions I'm not completely surprised if I missed something but for the most part this looks good
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Keeping in mind that the motor stuff appears to be handled in another PR, I'd still really like somebody else to also take a look at this before this gets merged, mostly because it feels like my brain goes into trance after the fifth board description and I don't feel confident enough to say that my review is enough.
I can say that it builds everything & looks alright in doxygen. Thank you for this PR :)
|
Scrolled through it in the aforementioned trance mode and found nothing to complain about. lgtm |
|
Will this now have to wait for #20429? I don't think this can even be merged right now, due to the failing CI test for code that you didn't really touch. |
0a583b5 to
a626a3c
Compare
I updated the exclude pattern file that previously already included the warnings. The reason this popped up is that the warnings are now not in a group but in a file. |

Contribution description
Inspired by the work of grouping common code and the new
*.doc.mdsyntax, I started to deduplicate the documentation of the STM32 Nucleo boards.This PR includes:
Move Nucleo32 Boards todone in boards: rename doc.txt -> doc.md for boards which name's starts from e to p #21641doc.mdformatMove Nucleo64 Boards todone in boards: rename doc.txt -> doc.md for boards which name's starts from e to p #21641doc.mdformatMove Nucleo144 Boards toalready done in boards/nucleo-144: rename doc.txt to doc.md #21318doc.mdformatdoc.mdfiles for Nucleo32, Nucleo64 and Nucleo144boards/common/nucleoXX/include/board.hin the Nucleo32/64/144 groupCreate asuperseded by doc/guides: add STM32 Flashing Guide #21767boards/common/nucleo/flashing.doc.mdpage that contains about the Flashing process.Add information about the toolchain to the common pages.Decided against it.Testing procedure
Check that the documentation looks beautiful.
Issues/PRs references
Depends on #21319.Update: now merged.Depends on #21767.Update: now merged.Progress for Tracking Issue #21220.