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

kconfig: experimental settings now uses select EXPERIMENTAL #39473

Merged
merged 7 commits into from
Oct 25, 2021
Merged

kconfig: experimental settings now uses select EXPERIMENTAL #39473

merged 7 commits into from
Oct 25, 2021

Conversation

tejlmand
Copy link
Collaborator

@tejlmand tejlmand commented Oct 15, 2021 •
edited
Loading

Continuation of: #33566

This PR is opened independently to allow proper review of all setting having experimental in their title, as requested at API-meeting:
See #33566 (comment)

Review all options that are currently marked as EXPERIMENTAL in their title

To reviewers, the important thing to review is not whether the select EXPERIMENTAL is correct but to consider whether or not the feature itself is still experimental or if EXPERIMENTAL should be removed.

If approving the PR, then please make a comment regarding which area you have verified, for example:

EXPERIMENTAL on subsys/net verified

Also, if you have the knowledge, then as per: https://lwn.net/Articles/520867/

For items that really are experimental, maintainers should use "default
n", optionally include "(EXPERIMENTAL)" in the title, and add language to
the help text indicating why the item should be considered experimental.

feel free to add a comment under the setting stating why the feature is considered experimental and I will update the help text with the proposed text in this PR.

@tejlmand tejlmand mentioned this pull request Oct 15, 2021
Merged
@tejlmand
Copy link
Collaborator Author

@jithu83 you added EXPERIMENTAL on crypto parts.

Are those still to be considered experimental ?

zephyr/drivers/crypto/Kconfig

Lines 22 to 24 in de106b0

menuconfig CRYPTO
bool
prompt "Crypto Drivers [EXPERIMENTAL]"

zephyr/drivers/crypto/Kconfig

Lines 47 to 48 in de106b0

config CRYPTO_TINYCRYPT_SHIM
bool "Enable TinyCrypt shim driver [EXPERIMENTAL] "

@tejlmand
Copy link
Collaborator Author

tejlmand commented Oct 22, 2021 •
edited
Loading

@tbursztyka you added EXPERIMENTAL on CRYPTO_MBEDTLS_SHIM.

Is this still to be considered experimental ?

zephyr/drivers/crypto/Kconfig

Lines 64 to 65 in 7abf3c5

config CRYPTO_MBEDTLS_SHIM
bool "Enable mbedTLS shim driver [EXPERIMENTAL] "

and here for SPI_SLAVE:

zephyr/drivers/spi/Kconfig

Lines 34 to 35 in 29a68cd

config SPI_SLAVE
bool "Enable Slave support [EXPERIMENTAL]"

@tejlmand
Copy link
Collaborator Author

@cfriedt you added EXPERIMENTAL on GPIO_EMUL.

Is this still to be considered experimental ?

zephyr/drivers/gpio/Kconfig.emul

Lines 6 to 7 in 724ee49

config GPIO_EMUL
bool "[EXPERIMENTAL] Emulated GPIO driver"

@tejlmand tejlmand requested a review from cfriedt October 22, 2021 08:45
@tejlmand
Copy link
Collaborator Author

@gmarull you added EXPERIMENTAL on MEMC.

Is this still to be considered experimental ?

zephyr/drivers/memc/Kconfig

Lines 6 to 7 in e671d36

menuconfig MEMC
bool "Memory controllers [EXPERIMENTAL]"

@gmarull
Copy link
Member

gmarull commented Oct 22, 2021

@gmarull you added EXPERIMENTAL on MEMC.

Is this still to be considered experimental ?

zephyr/drivers/memc/Kconfig

Lines 6 to 7 in e671d36

menuconfig MEMC
bool "Memory controllers [EXPERIMENTAL]"

yes

@tejlmand
Copy link
Collaborator Author

@mike-scott you added EXPERIMENTAL on MODEM_CONTEXT.

Is this still to be considered experimental ?

zephyr/drivers/modem/Kconfig

Lines 42 to 43 in 90e778d

config MODEM_CONTEXT
bool "Modem context helper driver [EXPERIMENTAL]"

@tejlmand
Copy link
Collaborator Author

@FRASTM you added EXPERIMENTAL on STM32_LPTIM_TIMER.

Is this still to be considered experimental ?

zephyr/drivers/timer/Kconfig.stm32_lptim

Lines 6 to 7 in f30f5ff

menuconfig STM32_LPTIM_TIMER
bool "STM32 Low Power Timer [EXPERIMENTAL]"

@tejlmand tejlmand requested a review from FRASTM October 22, 2021 09:00
@pfalcon
Copy link
Contributor

pfalcon commented Oct 22, 2021

@tejlmand:

@pfalcon you added EXPERIMENTAL on the console subsys.

That was done to allow to perform break'ish changes to the API. By "break'ish" I mean something like changing function signature or breaking up/merging configuration setting methods, because at the more abstract level, the core of the API is there and clear. I don't think we had changes to this subsys recently, so if there's a desire to remove EXPERIMENTAL status, that can be done.

@tejlmand
Copy link
Collaborator Author

so if there's a desire to remove EXPERIMENTAL status, that can be done.

With the introduction of select EXPERIMENTAL there is a desire and a good opportunity to checkup on the current settings to see if they are still considered EXPERIMENTAL.

No special wish to remove the setting as such, but such flags tend to be forgotten over time so just using the opportunity as requested at API meeting.

jukkar
jukkar approved these changes Oct 22, 2021
View reviewed changes
Copy link
Member

@jukkar jukkar left a comment

Choose a reason for hiding this comment

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

+1 to networking changes

@tejlmand
Copy link
Collaborator Author

I don't think we had changes to this subsys recently,

not related to the API, so I agree that it seems safe to remove EXPERIMENTAL here if the stability of the API was the reason.

@cfriedt
Copy link
Member

cfriedt commented Oct 22, 2021

@cfriedt you added EXPERIMENTAL on GPIO_EMUL.

Is this still to be considered experimental ?

zephyr/drivers/gpio/Kconfig.emul

Lines 6 to 7 in 724ee49

config GPIO_EMUL
bool "[EXPERIMENTAL] Emulated GPIO driver"

Probably not experimental anymore

@pfalcon
Copy link
Contributor

pfalcon commented Oct 22, 2021

@tejlmand

With the introduction of select EXPERIMENTAL there is a desire and a good opportunity to checkup on the current settings to see if they are still considered EXPERIMENTAL.

Right, it wouldn't be a good idea for this subsys to be hidden by default, so I posted #39654 to remove EXPERIMENTAL flag from subsys/console.

@tejlmand
Copy link
Collaborator Author

@cfriedt EXPERIMENTAL removed.

@tejlmand
kconfig: uart: remove experimental on UART_ASYNC_API setting
d9a1ff1 
The setting UART_ASYNC_API is no longer considered experimental.
Also remove `new` from title and help test as the feature no longer can
be considered new.

Signed-off-by: Torsten Rasmussen <[email protected]>
@tejlmand
kconfig: gpio: remove experimental on GPIO_EMUL setting
194e9ba 
The setting GPIO_EMUL is no longer considered experimental.

Signed-off-by: Torsten Rasmussen <[email protected]>
@tejlmand
kconfig: net: experimental settings now uses select EXPERIMENTAL
5cec328 
With the introduction of `EXPERIMENTAL` and `WARN_EXPERIMENTAL` in
Zephyr all subsys/net and drivers/ethernet/Kconfig.e1000 settings
having `[EXPERIMENTAL]` in their prompt has has been updated to include
`select EXPERIMENTAL` so that developers can enable warnings when
experimental features are enabled.

The following settings has EXPERIMENTAL removed as they are considered
mature:
- NET_OFFLOAD
- NET_PROMISCUOUS_MODE

Signed-off-by: Torsten Rasmussen <[email protected]>
@tejlmand
kconfig: drivers: experimental settings now uses select EXPERIMENTAL
a82b6d8 
With the introduction of `EXPERIMENTAL` and `WARN_EXPERIMENTAL` in
Zephyr all drivers settings having `[EXPERIMENTAL]` in their
prompt has has been updated to include `select EXPERIMENTAL` so that
developers can enable warnings when experimental features are enabled.

Signed-off-by: Torsten Rasmussen <[email protected]>
@tejlmand
kconfig: debug: experimental settings now uses select EXPERIMENTAL
7f80947 
With the introduction of `EXPERIMENTAL` and `WARN_EXPERIMENTAL` in
Zephyr all subsys/debug settings having `[EXPERIMENTAL]` in their
prompt has has been updated to include `select EXPERIMENTAL` so that
developers can enable warnings when experimental features are enabled.

Signed-off-by: Torsten Rasmussen <[email protected]>
@tejlmand
kconfig: lorawan: experimental settings now uses select EXPERIMENTAL
86abe30 
With the introduction of `EXPERIMENTAL` and `WARN_EXPERIMENTAL` in
Zephyr all subsys/lorawan settings having `[EXPERIMENTAL]` in their
prompt has has been updated to include `select EXPERIMENTAL` so that
developers can enable warnings when experimental features are enabled.

Signed-off-by: Torsten Rasmussen <[email protected]>
@tejlmand
kconfig: shell: experimental settings now uses select EXPERIMENTAL
965d221 
With the introduction of `EXPERIMENTAL` and `WARN_EXPERIMENTAL` in
Zephyr all subsys/shell settings having `[EXPERIMENTAL]` in their
prompt has has been updated to include `select EXPERIMENTAL` so that
developers can enable warnings when experimental features are enabled.

Signed-off-by: Torsten Rasmussen <[email protected]>
@carlescufi carlescufi merged commit 0a29a5a into zephyrproject-rtos:main Oct 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rugeGerritsen rugeGerritsen rugeGerritsen left review comments

@gmarull gmarull gmarull left review comments

@henrikbrixandersen henrikbrixandersen henrikbrixandersen approved these changes

@jukkar jukkar jukkar approved these changes

@joerchan joerchan joerchan approved these changes

@carlescufi carlescufi carlescufi approved these changes

@andyross andyross Awaiting requested review from andyross

@chen-png chen-png Awaiting requested review from chen-png

@dcpleung dcpleung Awaiting requested review from dcpleung

@mengxianglinx mengxianglinx Awaiting requested review from mengxianglinx

@mniestroj mniestroj Awaiting requested review from mniestroj

@rerickson1 rerickson1 Awaiting requested review from rerickson1

@tbursztyka tbursztyka Awaiting requested review from tbursztyka

@pfalcon pfalcon Awaiting requested review from pfalcon

@Mani-Sadhasivam Mani-Sadhasivam Awaiting requested review from Mani-Sadhasivam

@ceolin ceolin Awaiting requested review from ceolin

@rlubos rlubos Awaiting requested review from rlubos

@cfriedt cfriedt Awaiting requested review from cfriedt

@mike-scott mike-scott Awaiting requested review from mike-scott

@FRASTM FRASTM Awaiting requested review from FRASTM

Assignees

@tejlmand tejlmand

Labels
area: Bluetooth Audio area: Bluetooth Controller area: Bluetooth Host area: Bluetooth Mesh area: Bluetooth area: CAN area: Console area: Crypto / RNG area: Debugging area: Ethernet area: GPIO area: Kconfig area: LoRa area: Modem area: Networking area: Shell Shell subsystem area: Sockets Networking sockets area: SPI SPI bus area: Timer Timer area: UART Universal Asynchronous Receiver-Transmitter DNM This PR should not be merged (Do Not Merge) platform: STM32 ST Micro STM32
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.