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

feat(docs): Add troubleshooting section for empty_file error #2212

Merged
merged 1 commit into from
Mar 20, 2024

Conversation

filterpaper
Copy link
Contributor

Add a troubleshooting section for empty_file.c lacks #binding-cells error

@caksoylar caksoylar added the documentation Improvements or additions to documentation label Mar 19, 2024
@filterpaper
Copy link
Contributor Author

Thanks for the feedback. Suggestions are committed.

```

This error can be triggered by incorrect binding syntax such as `&kp BT_SEL 0` instead of `&bt BT_SEL 0`.

#### devicetree_unfixed.h error
Copy link
Contributor

Choose a reason for hiding this comment

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

Looking at this again, I wonder if this devicetree_unfixed.h is also a devicetree error which should be added to the above section rather than having its own header?

The example looks like the start devicetree error: was removed. Otherwise it looks like a similar error in which case it probably shouldn't have it's own heading?

Copy link
Contributor

Choose a reason for hiding this comment

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

Here is a recent variant of this error: https://github.com/l2yuk3n/zmk-config/actions/runs/8303562600/job/22727892620#step:11:120 It indeed doesn't start with devicetree error:.

I believe the wording is a bit different since the last Zephyr upgrade or two, so it would be good to update it. For instance unfixed is now generated. I think it would make sense to merge this with this new section as well, since the root cause is very similar (or the same? mismatch between the binding and #parameters).

That being said we can do that in another PR.

Copy link
Contributor

@caksoylar caksoylar left a comment

Choose a reason for hiding this comment

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

Thanks again, I can merge this unless you decide you would like to address the new comment (it's fine to not do it right now, like I noted).

@filterpaper
Copy link
Contributor Author

Thanks again, I can merge this unless you decide you would like to address the new comment (it's fine to not do it right now, like I noted).

Lets merge this particular PR if you are fine with the empty_file error. The current "devicetree_generated.h" message is a different context.

Copy link
Contributor

@caksoylar caksoylar left a comment

Choose a reason for hiding this comment

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

Thanks!

@caksoylar caksoylar merged commit 1f7cd7a into zmkfirmware:main Mar 20, 2024
7 checks passed
@filterpaper filterpaper deleted the empty_file_error branch March 20, 2024 06:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants