Skip to content

ci(check_toc_txt): add warning for files not in toc #463

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

ci(check_toc_txt): add warning for files not in toc #463

wants to merge 2 commits into from

Conversation

@StaticRocket
Copy link
Member

Add a new warning for RST files in the source directory that are unreachable, as they are not listed in any device table of contents.

Do not merge this until the following warnings are fixed:

WARNING:root:File not in any toc: source/devices/AM62X/linux/Release_Specific_Workarounds.rst
WARNING:root:File not in any toc: source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/AM65X_PRU_ICSSG_boards.rst
WARNING:root:File not in any toc: source/devices/AM62PX/linux/Overview/Run_Setup_Scripts.rst
WARNING:root:File not in any toc: source/linux/Foundational_Components/Machine_Learning/tflite_j7.rst
WARNING:root:File not in any toc: source/devices/AM62DX/linux/Release_Specific_Kernel_Performance_Guide.rst
WARNING:root:File not in any toc: source/devices/AM62PX/linux/Overview/Build_and_Run_the_Demos.rst
WARNING:root:File not in any toc: source/devices/AM62DX/linux/Overview/Build_and_Run_the_Demos.rst
WARNING:root:File not in any toc: source/devices/AM62DX/linux/Overview/Run_Setup_Scripts.rst
WARNING:root:File not in any toc: source/devices/AM62LX/linux/Overview/Run_Setup_Scripts.rst
WARNING:root:File not in any toc: source/devices/AM62AX/linux/Overview/Run_Setup_Scripts.rst
WARNING:root:File not in any toc: source/edgeai/dmpac_demos.rst
WARNING:root:File not in any toc: source/linux/Foundational_Components/Power_Management/pm_rtc_ddr.rst
WARNING:root:File not in any toc: source/devices/AM62X/linux/Overview/Build_and_Run_the_Demos.rst
WARNING:root:File not in any toc: source/devices/AM64X/linux/Overview/Create_SD_Card.rst
WARNING:root:File not in any toc: source/devices/AM64X/linux/Release_Specific_Workarounds.rst
WARNING:root:File not in any toc: source/devices/AM62X/linux/Overview/Run_Setup_Scripts.rst
WARNING:root:File not in any toc: source/devices/AM64X/linux/Release_Specific_Supported_Platforms_and_Versions.rst
WARNING:root:File not in any toc: source/devices/AM62LX/linux/Overview/Build_and_Run_the_Demos.rst
WARNING:root:File not in any toc: source/devices/AM64X/linux/Overview/Build_and_Run_the_Demos.rst
WARNING:root:File not in any toc: source/devices/AM62DX/linux/RT_Linux_Performance_Guide.rst
WARNING:root:File not in any toc: source/devices/AM62DX/linux/Linux_Performance_Guide.rst
WARNING:root:File not in any toc: source/devices/AM62DX/linux/Release_Specific_Migration_Guide.rst

@StaticRocket
Copy link
Member Author

How do we feel about handling these files? I would normally just delete them since they are unreachable currently anyway, but I figure there may be some opinions about that.

@github-actions
Copy link

New unreachable files found with check-files.sh:

source/images/edgeai/sde_dataflow.png
source/images/edgeai/dof_dataflow.png
source/images/Am65x_idk.jpg
source/images/Am65x_GP_EVM.jpg

@StaticRocket
ci(check_toc_txt): add warning for files not in toc
10b391b 
Add a new warning for RST files in the source directory that are
unreachable, as they are not listed in any device table of contents.

Signed-off-by: Randolph Sapp <[email protected]>
@StaticRocket
fix(unreachable): purge all unreachable files
47de855 
Purge any currently unclaimed files to allow this CI process to work
properly moving forward.

Signed-off-by: Randolph Sapp <[email protected]>
@github-actions
Copy link

New unreachable files found with check_files.py:

INFO:root:File not used: Jailhouse.png
INFO:root:File not used: _TMDSEVM6657L_EVM_Hardware_Setup.rst
INFO:root:File not used: _Release_Specific_PLL.rst
INFO:root:File not used: _TMDXEVM6670L_EVM_Hardware_Setup.rst
INFO:root:File not used: _TMDXEVM6678L_EVM_Hardware_Setup.rst

@StaticRocket
Copy link
Member Author

Those are the generic warnings that are addressed in #503 . Not added as a result of this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cshilwant cshilwant Awaiting requested review from cshilwant cshilwant is a code owner

@praneethbajjuri praneethbajjuri Awaiting requested review from praneethbajjuri praneethbajjuri is a code owner

@uditkumarti uditkumarti Awaiting requested review from uditkumarti uditkumarti is a code owner

@aniket-l aniket-l Awaiting requested review from aniket-l aniket-l is a code owner

@VeeruPrudhvi VeeruPrudhvi Awaiting requested review from VeeruPrudhvi VeeruPrudhvi is a code owner

At least 2 approving reviews are required to merge this pull request.

Assignees

@praneethbajjuri praneethbajjuri

@devarsht devarsht

@r-vignesh r-vignesh

@bryanbrattlof bryanbrattlof

@DhruvaG2000 DhruvaG2000

@aniket-l aniket-l

@uditkumarti uditkumarti

@vishalmti vishalmti

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

9 participants

@StaticRocket @praneethbajjuri @devarsht @r-vignesh @bryanbrattlof @DhruvaG2000 @aniket-l @uditkumarti @vishalmti