Skip to content

chore(i2c): Update kconfig docstrings and deprecation warning for completeness and helpfulness#508

Merged
finger563 merged 1 commit intomainfrom
chore/i2c-kconfig-doc-update
Aug 21, 2025
Merged

chore(i2c): Update kconfig docstrings and deprecation warning for completeness and helpfulness#508
finger563 merged 1 commit intomainfrom
chore/i2c-kconfig-doc-update

Conversation

@finger563
Copy link
Copy Markdown
Contributor

@finger563 finger563 commented Aug 21, 2025

Description

  • Update the i2c/Kconfg to have more up-to-date information regarding when the i2c legacy driver will be deprecated (esp-idf >= v6.0)
  • Update i2c.hpp deprecation warning to include information about how to turn off the deprecation warning to help people :)

Motivation and Context

  • Improves the docs
  • Helps people understand that they can disable the deprecation warning if they choose to.

How has this been tested?

  • Build and run i2c/example

Screenshots (if appropriate, e.g. schematic, board, console logs, lab pictures):

Updated deprecation warning:
CleanShot 2025-08-21 at 10 18 18

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update
  • Hardware (schematic, board, system design) change
  • Software change

Checklist:

  • My change requires a change to the documentation.
  • I have added / updated the documentation related to this change via either README or WIKI

Software

  • I have added tests to cover my changes.
  • I have updated the .github/workflows/build.yml file to add my new test to the automated cloud build github action.
  • All new and existing tests passed.
  • My code follows the code style of this project.

@finger563 finger563 self-assigned this Aug 21, 2025
@finger563 finger563 added enhancement New feature or request i2c labels Aug 21, 2025
@github-actions
Copy link
Copy Markdown

✅Static analysis result - no issues found! ✅

@finger563 finger563 merged commit 715cf3a into main Aug 21, 2025
82 of 93 checks passed
@finger563 finger563 deleted the chore/i2c-kconfig-doc-update branch August 21, 2025 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request i2c

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant