fix(all-toc-issues): repair all toc issues and add a check for the future #318
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
StaticRocket
requested review from
cshilwant,
praneethbajjuri,
uditkumarti,
aniket-l and
VeeruPrudhvi
as code owners
|
This script will fail initially as it will try to go back to a merge commit before the script was available. That's expected behavior in all workflows using |
praneethbajjuri
previously approved these changes
Jun 11, 2025
cshilwant
previously requested changes
Jun 13, 2025
Add a script to find invalid / outdated toc.txt entries. This replaces the older, faster, but more sloppy check-configs.sh script. I say the old version was more sloppy as it didn't treat comments quite the same as the rest of the tools here. It was a quick and dirty check. Signed-off-by: Randolph Sapp <rs@ti.com>
The files were removed in the below commit. Fixes: 8db942b (feat(linux): Update Machine Learning section for SDK 11.0, 2025-03-25) Signed-off-by: Randolph Sapp <rs@ti.com>
This file was renamed in the below commit. Fixes: f1723aa (Power Management: Move under Foundational_Components, 2024-08-07) Signed-off-by: Randolph Sapp <rs@ti.com>
This was never a stand alone file and include files should not be mentioned here. Signed-off-by: Randolph Sapp <rs@ti.com>
This page used to exist, but it was removed in the below commit. Fixes: 3f466a0 (U-Boot: remove the empty ReleaseNotes page, 2021-01-22) Signed-off-by: Randolph Sapp <rs@ti.com>
These files were deleted in the below commit. Fixes: 9ff6b42 (AM62X: Removed unused content, 2022-07-29) Signed-off-by: Randolph Sapp <rs@ti.com>
The files were renamed in the below commit. Fixes: d813f2a (graphics: split or merge appropriate sections, 2024-07-05) Signed-off-by: Randolph Sapp <rs@ti.com>
These files were deleted in the below commit. Fixes: 18f173a (AM62X/AM62PX: Android: Remove outdated documentation sources, 2024-07-25) Signed-off-by: Randolph Sapp <rs@ti.com>
This file was deleted in the below commit. Fixes: b03a8bf (docs(linux): cleanup Release_Specific_Migration_Guide.rst, 2025-03-31) Signed-off-by: Randolph Sapp <rs@ti.com>
This is case sensitive. A typo was resulting in a failed match. Fixes: 1af0207 (fix: configs: Add CMA Guide to Plaforms TOC, 2025-03-24) Signed-off-by: Randolph Sapp <rs@ti.com>
File does not yet exist. Entry was copied from another platform. Fixes: 98f5e6f (feat(linux): Initial documentation support for AM62L platform., 2025-02-21) Signed-off-by: Randolph Sapp <rs@ti.com>
This file was deleted in the below commit. Fixes: c231ab6 (fix(wave5): Update Wave5 Multimedia Documentation, 2024-10-31) Signed-off-by: Randolph Sapp <rs@ti.com>
This should have been a part of the below cleanup. Fixes: 7814a12 (Power_Management: fix toctree entries, 2024-03-19) Signed-off-by: Randolph Sapp <rs@ti.com>
This was introduced as a typo in the below commit. Fixes: 2ac7133 (J784S4: Add hardware setup page for AM69-SK, 2023-07-19) Signed-off-by: Randolph Sapp <rs@ti.com>
The file was removed in the below commit. Fixes: 13dc20b (Foundational SDK J7: TOC: Remove no-longer-supported Wifi demo, 2024-07-31) Signed-off-by: Randolph Sapp <rs@ti.com>
The file was removed in the below commit. Fixes: 56fc2a7 (PRU-ICSS: Remove ICSS_EMAC PRU-ICSS references, 2022-01-12) Signed-off-by: Randolph Sapp <rs@ti.com>
This file was renamed in the below commit. Fixes: 9dec3bc (PRU: Add PRU Subsystem information, 2022-06-08) Signed-off-by: Randolph Sapp <rs@ti.com>
The file was removed in the below commit. Fixes: f1c9731 (docs(linux): cleanup coresdk Performance Guide pages, 2024-12-08) Signed-off-by: Randolph Sapp <rs@ti.com>
The file was renamed in the below commit. Fixes: 5c4449a (Kernel_Drivers/Network/CPSW-TSN: Clean up TSN documentation and testing, 2022-10-17) Signed-off-by: Randolph Sapp <rs@ti.com>
Add a CI workflow to lock this progress. Hopefully this will alert us of whenever any damaging changes are occurring to the toc files in the future. Signed-off-by: Randolph Sapp <rs@ti.com>
praneethbajjuri
approved these changes
Jun 13, 2025
jeevantelukula
approved these changes
Jun 16, 2025
StaticRocket
dismissed
cshilwant’s stale review
Glitched. Asked for re-review but it didn't clear this old comment.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the wake of #314 I realized there were actually a lot of bugs being introduced in arbitrary commits over the years. This fixes all of those and adds some checks to prevent that in the future.