Skip to content
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

boards/nucleo144: doc update - usage of cpy2remed programmer and short overview of board #18291

Merged
merged 12 commits into from
Jul 4, 2022
Merged

boards/nucleo144: doc update - usage of cpy2remed programmer and short overview of board #18291

merged 12 commits into from
Jul 4, 2022

Conversation

krzysztof-cabaj
Copy link
Contributor

@krzysztof-cabaj krzysztof-cabaj commented Jul 3, 2022 •
edited
Loading

Contribution description

PR #18057 enables cpy2remed programmer for all STM Nucleo boards.

This PR adds to nucleo144 boards documentation:

  • information about usage of cpy2remed programmer,
  • short information about board (used MCU, available RAM and Flash),
  • change all memory sizes to KiB (before kB or Kb are used) .

Testing procedure

Changes in documentation can be observed using commands:

make doc
xdg-open doc/doxygen/html/group__boards__nucleo-f207zg.html 
xdg-open doc/doxygen/html/group__boards__nucleo-f303ze.html 
xdg-open doc/doxygen/html/group__boards__nucleo-f412zg.html 
xdg-open doc/doxygen/html/group__boards__nucleo-f413zh.html 
xdg-open doc/doxygen/html/group__boards__nucleo-f722ze.html 
xdg-open doc/doxygen/html/group__boards__nucleo-f746zg.html 
xdg-open doc/doxygen/html/group__boards__nucleo-f767zi.html
xdg-open doc/doxygen/html/group__boards__nucleo-l496zg.html 
xdg-open doc/doxygen/html/group__boards__nucleo144-l4r5.html

Or observed directly in documentation generated by CI

Issues/PRs references

Depends on PR #18057

@github-actions github-actions bot added Area: boards Area: Board ports Area: doc Area: Documentation labels Jul 3, 2022
@maribu maribu added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Jul 4, 2022
maribu
maribu approved these changes Jul 4, 2022
View reviewed changes
Copy link
Member

@maribu maribu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK. Thanks for addressing this! :)

@maribu maribu enabled auto-merge July 4, 2022 12:16
@maribu
Copy link
Member

maribu commented Jul 4, 2022

Some commit messages have too long names (> 72 chars in the first line), check https://github.com/RIOT-OS/RIOT/runs/7180298194?check_suite_focus=true for the CI output naming the commits that need to be shortened. Don't worry about the 50 chars warning, this is hard to maintain with our policy of prefixing commits with the subsystem anyway.

I'm not sure if you are a git power user. Just in case you are not: You can use git rebase -i <FIRST_COMMIT_BEFORE_YOUR_PR> (e.g. git rebase -i 32a1c22e76e1fadf37362faa8c8f042a76f6afda in this case) and use replace the pick in front of the commits with too long titles with reword (or just r). Then you will be asked to modify the affected commit messages. With git --force-with-lease you can push the new history in this PR.

auto-merge was automatically disabled July 4, 2022 18:04

Head branch was pushed to by a user without write access

@krzysztof-cabaj
Copy link
Contributor Author

krzysztof-cabaj commented Jul 4, 2022 •
edited
Loading

Thank for approval and some useful git commands. This time everything should be OK.

BTW. My push disable auto-merge :(

@maribu maribu merged commit 1e17aae into RIOT-OS:master Jul 4, 2022
@chrysn chrysn added this to the Release 2022.07 milestone Aug 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maribu maribu maribu approved these changes

@aabadie aabadie Awaiting requested review from aabadie aabadie is a code owner

@fjmolinas fjmolinas Awaiting requested review from fjmolinas

Assignees
No one assigned
Labels
Area: boards Area: Board ports Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR
Projects
None yet
Milestone
Release 2022.07
Development

Successfully merging this pull request may close these issues.
3 participants
@krzysztof-cabaj @maribu @chrysn