Skip to content

cpu: rename doc txt -> doc.md#21680

Merged
crasbe merged 4 commits intoRIOT-OS:masterfrom
krzysztof-cabaj:cpu_rename_doc_txt
Sep 5, 2025
Merged

cpu: rename doc txt -> doc.md#21680
crasbe merged 4 commits intoRIOT-OS:masterfrom
krzysztof-cabaj:cpu_rename_doc_txt

Conversation

@krzysztof-cabaj
Copy link
Copy Markdown
Contributor

Contribution description

This PR moves doc.txt to doc.md in cpu directory accordingly to the guide from ISSUE #21220.

In touched files I correct indentation for lines with @ - to 12 or 16 spaces, depending of the source.

Testing procedure

Generate doc and check if everything looks good:

make doc
xdg-open ./doc/doxygen/html/group__cpu__arm7__common.html 
xdg-open ./doc/doxygen/html/group__cpu__atmega8.html 
xdg-open ./doc/doxygen/html/group__cpu__esp32.html 
xdg-open ./doc/doxygen/html/group__cpu__sam3.html 
xdg-open ./doc/doxygen/html/group__cpu__stm32.html 
.  .  . 

Issues/PRs references

PR #21220

@github-actions github-actions bot added Platform: MSP Platform: This PR/issue effects MSP-based platforms Platform: ARM Platform: This PR/issue effects ARM-based platforms Area: doc Area: Documentation Platform: AVR Platform: This PR/issue effects AVR-based platforms Platform: ESP Platform: This PR/issue effects ESP-based platforms Platform: RISC-V Platform: This PR/issue effects RISC-V-based platforms Area: cpu Area: CPU/MCU ports labels Aug 22, 2025
@crasbe crasbe added Type: cleanup The issue proposes a clean-up / The PR cleans-up 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 Aug 22, 2025
@riot-ci
Copy link
Copy Markdown

riot-ci commented Aug 22, 2025

Murdock results

✔️ PASSED

d0decbd cpu: rename doc.txt -> doc.md for remaining CPUs

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

Artifacts

Comment on lines +1 to +7
<!--
Copyright (C) 2013 Freie Universität Berlin

This file is subject to the terms and conditions of the GNU Lesser
General Public License v2.1. See the file LICENSE in the top level
directory for more details.
-->
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Did you want to migrate the copyright notices in doc.md files in a separate step or now?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

If you talk about moving to SPDX - I started moving Copyrights in cpu directory, and plan to make first PR in following days.

@crasbe
Copy link
Copy Markdown
Contributor

crasbe commented Sep 5, 2025

The last commit has a typo: rname instead of rename.

@krzysztof-cabaj
Copy link
Copy Markdown
Contributor Author

Thanks for spotting ... fixed!

@crasbe crasbe enabled auto-merge September 5, 2025 12:20
@crasbe crasbe added this pull request to the merge queue Sep 5, 2025
auto-merge was automatically disabled September 5, 2025 13:39

Pull Request is not mergeable

Merged via the queue into RIOT-OS:master with commit 2809870 Sep 5, 2025
26 checks passed
@benpicco benpicco added this to the Release 2025.10 milestone Dec 3, 2025
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 Platform: ARM Platform: This PR/issue effects ARM-based platforms Platform: AVR Platform: This PR/issue effects AVR-based platforms Platform: ESP Platform: This PR/issue effects ESP-based platforms Platform: MSP Platform: This PR/issue effects MSP-based platforms Platform: RISC-V Platform: This PR/issue effects RISC-V-based platforms Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants