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

Add Petalinux/meta-adi Device Tree Information #9

Merged
merged 2 commits into from
Dec 19, 2024

Conversation

BrentK-ADI
Copy link
Contributor

In response to frequently asked customer questions, added documentation aimed to provide more details when working with device trees in Petalinux with meta-adi. This addition, expands upon the README file in the meta-adi repo, and provides a basic overview of meta-adi's device tree process, and procedures to perform the following:

  • Adjust a built-in device tree via system-user.dtsi
  • Add a custom device tree file to meta-user, but still leverage meta-adi process
  • Bypass meta-adi's device tree recipe, and use the Petalinux DTG for device tree, while still using the ADI kernel.

All procedures were dry-run by someone other than me to ensure accuracy.

BrentK-ADI and others added 2 commits December 16, 2024 17:38
Added documentation aimed to provide more details when working with device trees in Petalinux with meta-adi.
The documentation provides a basic overview of meta-adi's device tree process, and procedures to perform the following:
 - Adjust a built-in device tree via system-user.dtsi
 - Add a custom device tree file to meta-user, but still leverage meta-adi process
 - Bypass meta-adi's device tree recipe, and use the Petalinux DTG for device tree, while still using the ADI kernel.

Signed-off-by: Brent Kowal <[email protected]>
Reorder toctree directive, to append the pages to a coherent order in
the singlehtml/pdf output.
Drawio image as svg instead of png.
Minor style fixes.

Signed-off-by: Jorge Marques <[email protected]>
Copy link
Contributor

@gastmaier gastmaier left a comment

Choose a reason for hiding this comment

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

Hi @BrentK-ADI, added a review commit with minimal changes.
I noticed you used for-spaces to indent the directives, was this on purpose or just following your editor's default?
Generally in sphinx you indent according to the last character of the line, so directive 3-spaces:

.. some-directive:
   :some-option:

   Some Content

However, since using more spaces (4, 5, ..) consistently gives the same result, and I didn't want to nitpick, I'm ok merging as is.

When merging, please "Squash and Merge" and use your commit as title and message, that means
GUI title:

Add Petalinux/meta-adi Device Tree Information (#9)

Gui message:

Added documentation aimed to provide more details when working with device trees in Petalinux with meta-adi.
The documentation provides a basic overview of meta-adi's device tree process, and procedures to perform the following:
 - Adjust a built-in device tree via system-user.dtsi
 - Add a custom device tree file to meta-user, but still leverage meta-adi process
 - Bypass meta-adi's device tree recipe, and use the Petalinux DTG for device tree, while still using the ADI kernel.

Signed-off-by: Brent Kowal <[email protected]>````

@BrentK-ADI
Copy link
Contributor Author

@gastmaier, Thanks for the review! My first go at Sphinx, so still learning.

just following your editor's default?

Just following the default. I'll be cognizant of it next time and set up for 3 accordingly.

When merging, please "Squash and Merge" and use your commit as title and message, that means

I don't have write permissions for this repo, so I wont be able to merge myself. I can try to squash things on my branch to drive the PR, but if its an option for you to do during the merge, that's easier.

@gastmaier gastmaier merged commit 5e82db1 into analogdevicesinc:main Dec 19, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants