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

cli: Add command "dts-check" to validate dts files and improve board & patch development overall #6482

Merged
merged 2 commits into from
Apr 26, 2024

Conversation

ColorfulRhino
Copy link
Collaborator

Description

This new command can be used like this:

./compile.sh BOARD=nanopi-r5c BRANCH=edge dts-check

It validates the dts/dtb file for the selected board against dt bindings and outputs the validation logs to the user.
This can be used when adding a new board, developing or improving a dts file. Should lead to higher quality device trees and patches overall, if used.

Documentation summary for feature

  • short description (copy / paste of PR title)
    cli: Add command "dts-check" to validate dts files and improve board & patch development overall
  • summary (description relevant for end users)
    This command validates the dts/dtb file for the selected board against device tree bindings and outputs the validation logs to the user.
    It can be used when adding a new board, developing or improving a dts file. Should lead to higher quality device trees and patches overall, if used.
  • example of usage (how to see this in function)
./compile.sh BOARD=nanopi-r5c BRANCH=edge dts-check

Then wait for the validation to finish and check the output. If there is anything wrong with your board's device tree, you will see errors or warnings in the log. Analyze them carefully and use this information to improve your dts file.
Please note: Errors or warnings can also be introduced by SoC/board patches. When patching in new functions, like crypto for the RK3588, not only add the relevant parts to rk3588s.dtsi, but also try to add the device tree bindings in linux/Documentation/devicetree/bingings/ for validation.

How Has This Been Tested?

  • ./compile.sh BOARD=nanopi-r5c BRANCH=edge dts-check

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings

Validates the dts/dtb file for the selected board and outputs the validation logs to the user.
This can be used when adding a new board, developing or improving a dts file. Should lead to higher quality device trees and patches overall, if used.
@ColorfulRhino ColorfulRhino added the Needs Documentation New feature needs documentation entry label Apr 8, 2024
@ColorfulRhino ColorfulRhino requested a review from a team as a code owner April 8, 2024 16:45
@github-actions github-actions bot added size/medium PR with more then 50 and less then 250 lines Framework Framework components labels Apr 8, 2024
@igorpecovnik igorpecovnik added Ready to merge Reviewed, tested and ready for merge 05 Milestone: Second quarter release labels Apr 26, 2024
@igorpecovnik igorpecovnik merged commit 54618c1 into armbian:main Apr 26, 2024
8 of 10 checks passed
@igorpecovnik
Copy link
Member

Does not build https://paste.armbian.com/patunibuki

@amazingfate
Copy link
Contributor

Maybe we need to update setuptools for python3.

@igorpecovnik
Copy link
Member

Looks like something else ... :(

igorpecovnik added a commit to armbian/documentation that referenced this pull request May 30, 2024
* Modified warning message and added "DEPRECATED" in the title of the page.

* Added the follwping PRs to the documentation (/Developer-Guide_Build-Options/):
- armbian/build#6482
- armbian/build#6376 and armbian/build#6392
- armbian/build#6354
- armbian/build#6353

* Update Developer-Guide_Build-Options.md

---------

Co-authored-by: Igor <igor@armbian.com>
@ColorfulRhino ColorfulRhino deleted the dtb-check branch June 25, 2024 17:56
@ColorfulRhino ColorfulRhino added Documentation finished New feature was properly added to docs and removed Needs Documentation New feature needs documentation entry labels Jul 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
05 Milestone: Second quarter release Documentation finished New feature was properly added to docs Framework Framework components Ready to merge Reviewed, tested and ready for merge size/medium PR with more then 50 and less then 250 lines
Development

Successfully merging this pull request may close these issues.

3 participants