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.

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

drivers: rtc: driver not marked experimental in Kconfig #59900

Closed
ghost opened this issue Jul 1, 2023 · 1 comment
Closed

drivers: rtc: driver not marked experimental in Kconfig #59900

ghost opened this issue Jul 1, 2023 · 1 comment
Labels
area: RTC Real Time Clock bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug

Comments

@ghost
Copy link

ghost commented Jul 1, 2023

Describe the bug

The RTC driver is marked experimental in the docs but the corresponding EXPERIMENTAL flag in Kconfig is missing.

To Reproduce

Build:

  1. Build an app with CONFIG_RTC=y and CONFIG_WARN_EXPERIMENTAL=y.
  2. No warning is issued on the console.

Configuration:

  1. Use your favorite Kconfig frontend, look up the RTC driver
  2. No hint is given that the RTC API is experimental

Expected behavior

The RTC API should issue build warnings and clearly mention in Kconfig help/description that it is an experimental API so that users know what they are dealing with.

Maybe this should be backported to 3.4 where most users will see the API for the first time?

See linked PR.

Impact

Annoyed users when breaking the API while it's not stable.

Logs and console output

see above

Environment (please complete the following information):

any

Additional context

see #19030 (comment)

@ghost ghost added the bug The issue is a bug, or the PR is fixing a bug label Jul 1, 2023
@henrikbrixandersen henrikbrixandersen added the area: RTC Real Time Clock label Jul 4, 2023
@jhedberg jhedberg assigned ghost Jul 4, 2023
@jhedberg jhedberg added the priority: low Low impact/importance bug label Jul 4, 2023
@ghost
Copy link
Author

ghost commented Jul 10, 2023

Closing as "won't fix" due to maintainer decision, see #59902 (comment)

@ghost ghost closed this as completed Jul 10, 2023
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: RTC Real Time Clock bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug
Projects
None yet
Development

No branches or pull requests

2 participants