Skip to content

docs(U-Boot): Refactor K3 and OMAP Build Guide #339

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jonaswood01
Copy link
Contributor

Mostly cleanup and organization. Some content updated on OMAP. Turns large build guide into its own section under U-Boot, with 6 pages under the build guide. Give feedback if content needs more updating, and I will address in future PR.

Copy link

github-actions bot commented Jul 1, 2025

New issues found with check_toc_txt.py:

WARNING:root:Invalid slug: configs/AM65X/AM65X_linux_toc.txt:22 linux/Foundational_Components/U-Boot/Release-Notes
WARNING:root:Invalid slug: configs/AM57X/AM57X_linux_toc.txt:24 linux/Foundational_Components/U-Boot/Release-Notes
WARNING:root:Invalid slug: configs/AM437X/AM437X_linux_toc.txt:25 linux/Foundational_Components/U-Boot/Release-Notes

Copy link

github-actions bot commented Jul 1, 2025

New warnings found with rstcheck:

source/linux/Foundational_Components/U-Boot/BG-Bootflow-OMAP.rst:39: (WARNING/2) Bullet list ends without a blank line; unexpected unindent.
source/linux/Foundational_Components/U-Boot/BG-Bootflow-OMAP.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "2" (ordinal 2)
source/linux/Foundational_Components/U-Boot/BG-Bootflow-OMAP.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "3" (ordinal 3)
source/linux/Foundational_Components/U-Boot/BG-Bootflow-OMAP.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)
source/linux/Foundational_Components/U-Boot/BG-Target-Images-K3.rst:9: (INFO/1) Duplicate implicit target name: "target images".
source/linux/Foundational_Components/U-Boot/BG-Target-Images-OMAP.rst:9: (INFO/1) Duplicate implicit target name: "target images".

Mostly cleanup and organization. Some content updated on OMAP.
Turns large build guide into its own section under U-Boot,
with 6 pages under the build guide. Give feedback if content
needs more updating, and I will address in future PR.

Signed-off-by: Jonas Wood <[email protected]>
Copy link

github-actions bot commented Jul 1, 2025

New issues found with check_toc_txt.py:

WARNING:root:Invalid slug: configs/AM65X/AM65X_linux_toc.txt:22 linux/Foundational_Components/U-Boot/Release-Notes
WARNING:root:Invalid slug: configs/AM57X/AM57X_linux_toc.txt:24 linux/Foundational_Components/U-Boot/Release-Notes
WARNING:root:Invalid slug: configs/AM437X/AM437X_linux_toc.txt:25 linux/Foundational_Components/U-Boot/Release-Notes

Copy link

github-actions bot commented Jul 1, 2025

New warnings found with rstcheck:

source/linux/Foundational_Components/U-Boot/BG-Bootflow-OMAP.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "2" (ordinal 2)
source/linux/Foundational_Components/U-Boot/BG-Bootflow-OMAP.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "3" (ordinal 3)
source/linux/Foundational_Components/U-Boot/BG-Bootflow-OMAP.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "4" (ordinal 4)

Copy link
Member

@cshilwant cshilwant left a comment

Choose a reason for hiding this comment

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

Resolve merge conflicts and failures reported by 3 workflows

Target Images
*************

.. rubric:: Target Images
Copy link
Member

Choose a reason for hiding this comment

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

Why the rubric after the section header?

Comment on lines +34 to +36
^^^^^^^^^^^^^^^^^^^^^^^
Getting the Source Code
^^^^^^^^^^^^^^^^^^^^^^^
Copy link
Member

Choose a reason for hiding this comment

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

Comment on lines +7 to +9
^^^^^^^^^^^^^^^^^^
U-Boot Environment
^^^^^^^^^^^^^^^^^^
Copy link
Member

Choose a reason for hiding this comment

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

| K2G ICE | ``k2g_evm_defconfig`` | | | | | | | |
+----------------------------+-----------------------------+--------------------------+----------------------------------------------+--------------------------+--------------------------+--------------------------+-----------------------------------------+------------------------------------------+
| OMAP-L138 LCDK | ``omapl138_lcdk_defconfig`` | | ``omapl138_lcdk_defconfig`` | | | | | |
+----------------------------+-----------------------------+--------------------------+----------------------------------------------+--------------------------+--------------------------+--------------------------+-----------------------------------------+------------------------------------------+
Copy link
Member

Choose a reason for hiding this comment

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

This would be much easier to review as a list-table

https://docutils.sourceforge.io/docs/ref/rst/directives.html#list-table


.. ifconfig:: CONFIG_part_variant in ('AM335X')

If you used 'O=am335x\_evm' as your object directory:
Copy link
Member

Choose a reason for hiding this comment

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

This is also applicable to other parameters listed here

Suggested change
If you used 'O=am335x\_evm' as your object directory:
If you used ``O=am335x_evm`` as your object directory:


UG-General-Info
Copy link
Member

Choose a reason for hiding this comment

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

You removed UG-General-Info, but left unreachable references in:

configs/AM69/AM69_linux_toc.txt
configs/AM68/AM68_linux_toc.txt
configs/J721S2/J721S2_linux_toc.txt
configs/TDA4VM/TDA4VM_linux_toc.txt
configs/AM67/AM67_linux_toc.txt
configs/J7200/J7200_linux_toc.txt
configs/GEN/GEN_linux_toc.txt
configs/J742S2/J742S2_linux_toc.txt
configs/AM68A/AM68A_linux_toc.txt
configs/DRA821A/DRA821A_linux_toc.txt
configs/AM67A/AM67A_linux_toc.txt
configs/AM69A/AM69A_linux_toc.txt
configs/J784S4/J784S4_linux_toc.txt
configs/J722S/J722S_linux_toc.txt
configs/J721E/J721E_linux_toc.txt

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.