fix(docs): Fix incorrect ARDUINO_USB_MODE for USB CDC usage #11971

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.

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

Merged

me-no-dev merged 1 commit into espressif:master from ejohnso49:docs-fix-usb-cdc-config-error

Nov 3, 2025

Merged

fix(docs): Fix incorrect ARDUINO_USB_MODE for USB CDC usage #11971

me-no-dev merged 1 commit into espressif:master from ejohnso49:docs-fix-usb-cdc-config-error

Nov 3, 2025

+1 −1

Conversation

@ejohnso49

Copy link

Contributor

@ejohnso49 ejohnso49 commented Oct 31, 2025

Description of Change

Fixes error in Troubleshooting page when enabling serial logging over the built-in USB CDC interface.

When enabling serial logging over the built-in USB CDC interface, both ARDUINO_USB_CDC_ON_BOOT and ARDUINO_USB_MODE should be set to 1

Test Scenarios

Tested this configuration to enable logging over the built-in USB CDC interface on an ESP32S3

@ejohnso49


 fix(docs): Fix incorrect ARDUINO_USB_MODE for USB CDC usage

a20317d

When enabling serial logging over the built-in USB CDC interface, both ARDUINO_USB_CDC_ON_BOOT and ARDUINO_USB_MODE should be set to 1

@ejohnso49 ejohnso49 requested a review from pedrominatel as a code owner

October 31, 2025 17:22

@CLAassistant

Copy link

CLAassistant commented Oct 31, 2025 •

edited

Loading

CLA assistant check
All committers have signed the CLA.

@github-actions

Copy link

Contributor

github-actions bot commented Oct 31, 2025

Warnings

⚠️

Some issues found for the commit messages in this PR:

the commit message "fix(docs): Fix incorrect ARDUINO_USB_MODE for USB CDC usage":
- body's lines must not be longer than 100 characters

Please fix these commit messages - here are some basic tips:

follow Conventional Commits style
correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
sufficiently descriptive message summary should be between 10 to 72 characters and start with upper case letter
avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 Hello ejohnso49, we appreciate your contribution to this project!

📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.

Click to see more instructions ...

This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...

We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against a20317d