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

Missing Kconfig checker (IDFGH-9516) #10872

Closed
3 tasks done
tadejg opened this issue Mar 1, 2023 · 4 comments
Closed
3 tasks done

Missing Kconfig checker (IDFGH-9516) #10872

tadejg opened this issue Mar 1, 2023 · 4 comments
Assignees
Labels
Resolution: NA Issue resolution is unavailable Status: Done Issue is done internally

Comments

@tadejg
Copy link

tadejg commented Mar 1, 2023

Answers checklist.

  • I have read the documentation ESP-IDF Programming Guide and the issue is not addressed there.
  • I have updated my IDF branch (master or release) to the latest version and checked that the issue is present there.
  • I have searched the issue tracker for a similar issue and not found a similar issue.

General issue report

Documentation mentions a Kconfig checker script here.

This script appears to have been removed in version v4.3.
Still exists in v4.2: https://github.com/espressif/esp-idf/blob/release/v4.2/tools/check_kconfigs.py
Doesn't exist in v4.3: https://github.com/espressif/esp-idf/blob/release/v4.3/tools/check_kconfigs.py

EDIT: As a workaround, I simply downloaded the script from version v4.2 into esp-idf/tools/check_kconfigs.py and ran it in my project using check_kconfigs.py -d .. Seems to work as expected.

@espressif-bot espressif-bot added the Status: Opened Issue is new label Mar 1, 2023
@github-actions github-actions bot changed the title Missing Kconfig checker Missing Kconfig checker (IDFGH-9516) Mar 1, 2023
@dobairoland
Copy link
Collaborator

The script has been moved from the tools to the tools/ci directory. Thanks for the report!

Also one doesn't have to use this directly. If the contribution guide is followed then the check should be part of the automatic pre-commit checks. The documentation clearly has to be updated and the corrections backported.

So @tadejg. If you do this part then the checker is run (together with others) when you make a git commit.

@igrr
Copy link
Member

igrr commented Mar 1, 2023

I think the key point here is

and ran it in my project using check_kconfigs.py -d .. Seems to work as expected.

so the use case, as i understand, is not to check commits in IDF repo, but to use the same tool to check the commits in a custom IDF-based project.

Perhaps we could make the tool available as part of https://github.com/espressif/esp-idf-kconfig package?

@DNedic
Copy link
Collaborator

DNedic commented Mar 1, 2023

@igrr Sounds like a good idea, the checking of kconfig file portion of the tool would be factored out and check_kconfigs.py would use that module from the esp-idf-kconfig package to check ESP-IDF directories.

@dobairoland
Copy link
Collaborator

The documentation is getting fixed by #10922 and e7747bd. The rest will be solved separately.

@espressif-bot espressif-bot added Status: In Progress Work is in progress and removed Status: Selected for Development Issue is selected for development labels Sep 11, 2023
@espressif-bot espressif-bot added Status: Reviewing Issue is being reviewed and removed Status: In Progress Work is in progress labels Sep 22, 2023
@espressif-bot espressif-bot added Status: Done Issue is done internally Resolution: NA Issue resolution is unavailable and removed Status: Reviewing Issue is being reviewed labels Oct 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Resolution: NA Issue resolution is unavailable Status: Done Issue is done internally
Projects
None yet
Development

No branches or pull requests

7 participants