Skip to content

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.

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
Draft
wants to merge 5 commits into
base: master
Choose a base branch
from
Draft

boards/nucleo*: Cleanup and Enhance the Documentation #21337

wants to merge 5 commits into from

Conversation

crasbe
Copy link
Contributor

@crasbe crasbe commented Mar 29, 2025 •
edited
Loading

Contribution description

Inspired by the work of grouping common code and the new *.doc.md syntax, I started to deduplicate the documentation of the STM32 Nucleo boards.

This PR includes:

  • Add P-Nucleo-WB55 to Nucleo64 group
  • Move Nucleo32 Boards to doc.md format
  • Move Nucleo64 Boards to doc.md format
  • Move Nucleo144 Boards to doc.md format already done in boards/nucleo-144: rename doc.txt to doc.md #21318
  • Create common doc.md files for Nucleo32, Nucleo64 and Nucleo144
  • Don't show the content of boards/common/nucleoXX/include/board.h in the Nucleo32/64/144 group
  • Add Nucleo-common information to these files (such as the LED0<->SPI issue raised in nucleo-f446re problem with using the led and spi at the same time #21336 by @tanneberger).
  • Create a boards/common/nucleo/flashing.doc.md page that contains about the Flashing process.
  • Replace the Flashing information for all Nucleo32 boards.
  • Replace the Flashing information for all Nucleo64 boards.
  • Replace the Flashing information for all Nucleo144 boards.
  • ????

This is still a draft, but I would like to get some early comments about whether this is a good direction or not before I edit all the other files.

Testing procedure

Check that the documentation looks beautiful.

Issues/PRs references

Depends on #21319. Update: now merged.

Progress for Tracking Issue #21220.

@crasbe crasbe added Area: doc Area: Documentation Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation State: waiting for other PR State: The PR requires another PR to be merged first labels Mar 29, 2025
@github-actions github-actions bot added the Area: boards Area: Board ports label Mar 29, 2025
@crasbe crasbe mentioned this pull request Mar 29, 2025
Merged
@crasbe
Copy link
Contributor Author

crasbe commented Mar 30, 2025

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

## Supported Toolchains
For using the ST Nucleo-F303K8 board we strongly recommend the usage of the
[GNU Tools for ARM Embedded Processors](https://launchpad.net/gcc-arm-embedded)
toolchain.

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: Launchpad is no longer used for the Arm GNU Toolchain releases.

The toolchain is now maintained at Arm: https://developer.arm.com/Tools%20and%20Software/GNU%20Toolchain
But most(?) distributions provide an gcc-arm-none-eabi package. Maybe that would be better to mention?

@crasbe crasbe removed the State: waiting for other PR State: The PR requires another PR to be merged first label Apr 1, 2025
@krzysztof-cabaj krzysztof-cabaj mentioned this pull request Aug 1, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aabadie aabadie Awaiting requested review from aabadie aabadie will be requested when the pull request is marked ready for review aabadie is a code owner

@jia200x jia200x Awaiting requested review from jia200x jia200x will be requested when the pull request is marked ready for review jia200x is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
Area: boards Area: Board ports Area: doc Area: Documentation Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@crasbe