Skip to content

cpu/stm32: rewrite clock configuration documentation#15265

Merged
benpicco merged 1 commit intoRIOT-OS:masterfrom
aabadie:pr/cpu/stm32_clock_doc
Oct 27, 2020
Merged

cpu/stm32: rewrite clock configuration documentation#15265
benpicco merged 1 commit intoRIOT-OS:masterfrom
aabadie:pr/cpu/stm32_clock_doc

Conversation

@aabadie
Copy link
Contributor

@aabadie aabadie commented Oct 21, 2020

Contribution description

This PR is a complete rewrite of the STM32 clock configuration documentation. It's part of #14975.
With the recent refactoring work on STM32 clock configuration, the current documentation is completely outdated.

Testing procedure

make doc and read (I'll report here when CircleCI doc build is ready)

Issues/PRs references

Tick an item in #14975

@aabadie aabadie added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Area: doc Area: Documentation Area: cpu Area: CPU/MCU ports CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Oct 21, 2020
@aabadie aabadie added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Oct 21, 2020
@aabadie aabadie force-pushed the pr/cpu/stm32_clock_doc branch from 704feb4 to 98224d2 Compare October 26, 2020 10:22
@aabadie
Copy link
Contributor Author

aabadie commented Oct 26, 2020

rebased and adapted after #15192 got merged.

@aabadie aabadie force-pushed the pr/cpu/stm32_clock_doc branch from 98224d2 to 6d764b1 Compare October 26, 2020 10:24
Copy link
Contributor

@benpicco benpicco left a comment

Choose a reason for hiding this comment

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

Looks good, nice overview.

@aabadie aabadie force-pushed the pr/cpu/stm32_clock_doc branch from 6d764b1 to 0bd70a4 Compare October 27, 2020 07:54
@benpicco benpicco merged commit ef4123d into RIOT-OS:master Oct 27, 2020
@aabadie aabadie deleted the pr/cpu/stm32_clock_doc branch November 16, 2021 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: cpu Area: CPU/MCU 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 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.

2 participants