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

cpu/esp32: update documentation for ESP32-C3 #18350

Merged
merged 1 commit into from
Jul 21, 2022
Merged

cpu/esp32: update documentation for ESP32-C3 #18350

merged 1 commit into from
Jul 21, 2022

Conversation

gschorcht
Copy link
Contributor

Contribution description

This PR is a split-off from PR #17844, which updates the documentation for ESP32-C3.

Testing procedure

Green CI without compilation test since only *.txt files are changed.

Issues/PRs references

@github-actions github-actions bot added Area: cpu Area: CPU/MCU ports Area: doc Area: Documentation Platform: ESP Platform: This PR/issue effects ESP-based platforms labels Jul 21, 2022
@gschorcht gschorcht added Type: new feature The issue requests / The PR implemements a new feature for RIOT 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 Jul 21, 2022
@gschorcht gschorcht changed the title cpu/esp32: add ESP32-C3 support in doc cpu/esp32: update documentation for ESP32-C3 Jul 21, 2022
@gschorcht gschorcht mentioned this pull request Jul 21, 2022
Merged
benpicco
benpicco approved these changes Jul 21, 2022
View reviewed changes
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.

No need to split off non-logic changes, but maybe this is then a good motivation to merge #18345 soon 😄

cpu/esp32/doc.txt
@@ -166,7 +166,7 @@ either based on
- Tensilica Xtensa 32-bit LX7 microprocessor (ESP32-S2, ESP32-S3), or
- 32-bit RISC-V CPU (ESP32-C3, ESP32-H2).

At the moment, ESP32 variant is supported by RIOT-OS.
At the moment, ESP32 and ESP32-C3 variants (families) are supported by RIOT-OS.
Copy link
Contributor

Choose a reason for hiding this comment

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

Now this is a lie until #18345 is merged 😉

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, but I think this is acceptable in a development branch for a short time. Initially I thought we could merge PR #18345 first and then this PR until I noticed that a reference to the documentation is used in the header files of PR #18345 😟

@gschorcht
Copy link
Contributor Author

No need to split off non-logic changes, but maybe this is then a good motivation to merge #18345 soon

I simply tried to reduce the size of the core PR as much as possible.

@benpicco benpicco enabled auto-merge July 21, 2022 11:05
@benpicco benpicco merged commit 6bd5b94 into RIOT-OS:master Jul 21, 2022
@gschorcht gschorcht deleted the cpu/esp32/add_esp32c3_support_doc branch July 21, 2022 13:45
@maribu maribu added this to the Release 2022.10 milestone Oct 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benpicco benpicco benpicco approved these changes

Assignees
No one assigned
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: ESP Platform: This PR/issue effects ESP-based platforms Type: new feature The issue requests / The PR implemements a new feature for RIOT
Projects
None yet
Milestone
Release 2022.10
Development

Successfully merging this pull request may close these issues.
3 participants
@gschorcht @benpicco @maribu