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

Each board should have a list of Kconfig options supported #20699

Closed
pfl opened this issue Nov 14, 2019 · 2 comments
Closed

Each board should have a list of Kconfig options supported #20699

pfl opened this issue Nov 14, 2019 · 2 comments
Labels
area: Kconfig Feature Request A request for a new feature

Comments

@pfl
Copy link
Collaborator

pfl commented Nov 14, 2019

While working on an for me unknown board, let's say for example FRDM k64f, it would be excellent to have all the possible board specific Kconfig options listed. I was looking for UART support, and figured out from the header file that the asynchronous UART API would be the best fit for my project.

Unfortunately the only way of figuring out whether said example board supports this particular UART API is to dig through several orders of Kconfig files in order to learn whether the #ifdef in the include file is supported or not or whether to redesign ones project to use the more basic API.

In order to solve this, I propose a script crawling through the board specific Kconfig options and other included Kconfig files that would output decently formatted documentation added for each board. That way the connection between the APIs documented in include/ can be mapped to board specific support - or actually vice versa.

@pfl pfl added bug The issue is a bug, or the PR is fixing a bug area: Kconfig labels Nov 14, 2019
@SebastianBoe SebastianBoe added Feature Request A request for a new feature and removed bug The issue is a bug, or the PR is fixing a bug labels Nov 14, 2019
@aescolar
Copy link
Member

CC @ulfalizer

@carlescufi
Copy link
Member

This is already in menuconfig or guiconfig. A list would be extremely long and not hierarchical, so I am not sure this would be usable. Closing for now, if you have a concrete proposal please reopen it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Kconfig Feature Request A request for a new feature
Projects
None yet
Development

No branches or pull requests

4 participants