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

Android: Document how to add new overlays in the dtbo.img #150

Merged

Conversation

makohoek
Copy link
Collaborator

@makohoek makohoek commented Jan 7, 2025

For Android newcomers, it's not trivial to know how to add new device tree
overlays. See [1]

Since it's different than the linux SDK, we should document it.

Add a section in the kernel guide for this.

[1] https://e2e.ti.com/support/processors-group/processors/f/processors-forum/1454200/sk-am62p-lp-sk-am62p-lp-androidautomotive-unable-to-get-the-dsi-port-up-and-running

While at it, also:

  • Fix a build warning about a missing file in the TOC
  • Reindent an implicit numbered list in the kernel guide

Cc: @vishalmti @glaroque

commit f8c988a ("feat(android): Move ota guide to Foundational_Components")
moved the ota guides to the generic Android documentation (Foundational
Components). However, the removed file is still listed in the device-specific TOCs.

This generates a build warning:

WARNING: toctree contains reference to nonexisting document 'devices/AM62X/android/

Fix the warning by removing the nonexisting OTA document.

Fixes: f8c988a ("feat(android): Move ota guide to Foundational_Components")
Signed-off-by: Mattijs Korpershoek <[email protected]>
For numbering to behave properly when a new paragraph is inserted,
implicit lists should be indented.

Reindent the list that describes how to add a new kernel module.

Signed-off-by: Mattijs Korpershoek <[email protected]>
Copy link
Member

@StaticRocket StaticRocket left a comment

Choose a reason for hiding this comment

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

Other than the formatting nit-picks this seems pretty straightforward

source/android/Foundational_Components_Kernel.rst Outdated Show resolved Hide resolved
source/android/Foundational_Components_Kernel.rst Outdated Show resolved Hide resolved
source/android/Foundational_Components_Kernel.rst Outdated Show resolved Hide resolved
source/android/Foundational_Components_Kernel.rst Outdated Show resolved Hide resolved
source/android/Foundational_Components_Kernel.rst Outdated Show resolved Hide resolved
The snippet comes from BUILD.bazel which is in bazel language.
According to [1], bazel is supported by pygments.

Use it instead of using bash.

[1] https://pygments.org/docs/lexers/#pygments.lexers.python.PythonLexer
Suggested-by: Randolph Sapp <[email protected]>
Signed-off-by: Mattijs Korpershoek <[email protected]>
For Android newcomers, it's not trivial to know how to add new device tree
overlays. See [1]

Since it's different than the linux SDK, we should document it.

Add a section in the kernel guide for this.

[1] https://e2e.ti.com/support/processors-group/processors/f/processors-forum/1454200/sk-am62p-lp-sk-am62p-lp-androidautomotive-unable-to-get-the-dsi-port-up-and-running
Signed-off-by: Mattijs Korpershoek <[email protected]>
@makohoek makohoek force-pushed the android-kernel-dtbo branch from 9a8aa57 to d0e2651 Compare January 8, 2025 08:29
@makohoek
Copy link
Collaborator Author

makohoek commented Jan 8, 2025

Change in v2:

  • Introduced a new commit to use bazel langage in code block instead of bash (Randolph)
  • Use bazel langage in newer code blocks as well (Randolph)
  • Removed confusing width in the dtbo table example (Randolph)

@makohoek makohoek requested a review from StaticRocket January 8, 2025 08:30
@praneethbajjuri praneethbajjuri merged commit fca008a into TexasInstruments:master Jan 8, 2025
3 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.

5 participants