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

Bugfix/nbs #36

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Conversation

StaticRocket
Copy link
Member

Fix various style issues and odd character usage that may affect rst parsers.

Copy link

github-actions bot commented Nov 7, 2024

New warnings found with rstcheck:

source/common/EVM_Hardware_Setup/_AM62x_EVM_Hardware_Setup.rst:8: (ERROR/3) Undefined substitution referenced: "reg".
source/common/EVM_Hardware_Setup/_AM572x_GP_EVM_Hardware_Setup.rst:11: (ERROR/3) Undefined substitution referenced: "reg".
source/common/EVM_Hardware_Setup/_J722S_EVM_Hardware_Setup.rst:8: (ERROR/3) Undefined substitution referenced: "reg".
source/common/EVM_Hardware_Setup/_66AK2G02_ICE_EVM_Hardware_setup.rst:15: (ERROR/3) Undefined substitution referenced: "reg".
source/common/EVM_Hardware_Setup/_AM62Px_EVM_Hardware_Setup.rst:8: (ERROR/3) Undefined substitution referenced: "reg".
source/devices/AM62AX/linux/Linux_Performance_Guide.rst:593: (INFO/1) Duplicate implicit target name: "am62axx-sk".
source/devices/AM62X/linux/Linux_Performance_Guide.rst:747: (INFO/1) Duplicate implicit target name: "am62xx-sk".
source/devices/J7_Family/linux/_Release_Specific_Kernel_Performance_Guide.rst:805: (INFO/1) Duplicate implicit target name: "j721e-idk-gw".
source/devices/AM62PX/linux/Linux_Performance_Guide.rst:717: (INFO/1) Duplicate implicit target name: "am62pxx-sk".
source/devices/AM64X/linux/RT_Linux_Performance_Guide.rst:611: (INFO/1) Duplicate implicit target name: "am64xx-evm".
source/linux/Release_Specific/Performance_Guide/_RT_Kernel_Performance_Guide.rst:261: (ERROR/3) Undefined substitution referenced: "reg".
source/linux/Release_Specific/Performance_Guide/_CoreSDK_RT_Kernel_Performance_Guide.rst:723: (INFO/1) Duplicate implicit target name: "am64xx-evm".
source/linux/Release_Specific/Performance_Guide/_Kernel_Performance_Guide.rst:851: (INFO/1) Duplicate implicit target name: "am654x-evm".
source/linux/Examples_and_Demos/_AM335x_Power_Management_User_Guide.rst:298: (ERROR/3) Undefined substitution referenced: "reg".
source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/AM65X_PRU_ICSSG_boards.rst:7: (ERROR/3) Undefined substitution referenced: "reg".
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/MMC-SD.rst:13: (ERROR/3) Undefined substitution referenced: "reg".
source/linux/Foundational_Components/IPC/_Multiple_Ways_of_ARM-DSP_Communication.rst:231: (WARNING/2) Line block ends without a blank line.
source/linux/Industrial_Protocols/_SORTE.rst:152: (INFO/1) Possible title underline, too short for the title.
source/rtos/PDK_Platform_Software/Device_Drivers/_TSIP.rst:18: (ERROR/3) Undefined substitution referenced: "micro".
source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_PRU_ICSS_SORTE.rst:21: (ERROR/3) Undefined substitution referenced: "micro".
source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_IOLINK_FIRMWARE.rst:33: (ERROR/3) Undefined substitution referenced: "micro".
source/rtos/How_to_Guides/Host/System_Integration/_IPC_Debugging_Tools_and_Techniques_on_AM57xx.rst:258: (INFO/1) Possible title underline, too short for the title.
source/rtos/Examples_and_Demonstrations/_Audio_Pre_Processing.rst:214: (INFO/1) Duplicate implicit target name: "am572x gp evm".

Copy link

github-actions bot commented Nov 7, 2024

New warnings found with rstcheck:

source/common/EVM_Hardware_Setup/_AM62x_EVM_Hardware_Setup.rst:8: (ERROR/3) Undefined substitution referenced: "reg".
source/common/EVM_Hardware_Setup/_AM572x_GP_EVM_Hardware_Setup.rst:11: (ERROR/3) Undefined substitution referenced: "reg".
source/common/EVM_Hardware_Setup/_J722S_EVM_Hardware_Setup.rst:8: (ERROR/3) Undefined substitution referenced: "reg".
source/common/EVM_Hardware_Setup/_66AK2G02_ICE_EVM_Hardware_setup.rst:15: (ERROR/3) Undefined substitution referenced: "reg".
source/common/EVM_Hardware_Setup/_AM62Px_EVM_Hardware_Setup.rst:8: (ERROR/3) Undefined substitution referenced: "reg".
source/devices/AM62AX/linux/Linux_Performance_Guide.rst:593: (INFO/1) Duplicate implicit target name: "am62axx-sk".
source/devices/AM62X/linux/Linux_Performance_Guide.rst:747: (INFO/1) Duplicate implicit target name: "am62xx-sk".
source/devices/J7_Family/linux/_Release_Specific_Kernel_Performance_Guide.rst:805: (INFO/1) Duplicate implicit target name: "j721e-idk-gw".
source/devices/AM62PX/linux/Linux_Performance_Guide.rst:717: (INFO/1) Duplicate implicit target name: "am62pxx-sk".
source/devices/AM64X/linux/RT_Linux_Performance_Guide.rst:611: (INFO/1) Duplicate implicit target name: "am64xx-evm".
source/linux/Release_Specific/Performance_Guide/_RT_Kernel_Performance_Guide.rst:261: (ERROR/3) Undefined substitution referenced: "reg".
source/linux/Release_Specific/Performance_Guide/_CoreSDK_RT_Kernel_Performance_Guide.rst:723: (INFO/1) Duplicate implicit target name: "am64xx-evm".
source/linux/Release_Specific/Performance_Guide/_Kernel_Performance_Guide.rst:851: (INFO/1) Duplicate implicit target name: "am654x-evm".
source/linux/Examples_and_Demos/_AM335x_Power_Management_User_Guide.rst:298: (ERROR/3) Undefined substitution referenced: "reg".
source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/AM65X_PRU_ICSSG_boards.rst:7: (ERROR/3) Undefined substitution referenced: "reg".
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/MMC-SD.rst:13: (ERROR/3) Undefined substitution referenced: "reg".
source/linux/Foundational_Components/IPC/_Multiple_Ways_of_ARM-DSP_Communication.rst:231: (WARNING/2) Line block ends without a blank line.
source/linux/Industrial_Protocols/_SORTE.rst:152: (INFO/1) Possible title underline, too short for the title.
source/rtos/PDK_Platform_Software/Device_Drivers/_TSIP.rst:18: (ERROR/3) Undefined substitution referenced: "micro".
source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_PRU_ICSS_SORTE.rst:21: (ERROR/3) Undefined substitution referenced: "micro".
source/rtos/PDK_Platform_Software/PRU_ICSS_Drivers/_IOLINK_FIRMWARE.rst:33: (ERROR/3) Undefined substitution referenced: "micro".
source/rtos/How_to_Guides/Host/System_Integration/_IPC_Debugging_Tools_and_Techniques_on_AM57xx.rst:258: (INFO/1) Possible title underline, too short for the title.
source/rtos/Examples_and_Demonstrations/_Audio_Pre_Processing.rst:214: (INFO/1) Duplicate implicit target name: "am572x gp evm".

@StaticRocket
Copy link
Member Author

Huh. So it appears that rstcheck doesn't know how to parse the standard substitution lists.

@StaticRocket
Copy link
Member Author

This PR now upgrades rstcheck to a version that can actually parse standard include directives.

Copy link

New warnings found with rstcheck:

[Errno 2] No such file or directory: 'g++'

cshilwant
cshilwant previously approved these changes Nov 10, 2024
@cshilwant
Copy link
Member

New warnings found with rstcheck:

[Errno 2] No such file or directory: 'g++'

@StaticRocket Why does it hunts for g++?

@StaticRocket
Copy link
Member Author

It's part of the code block checking. It uses GCC to check if a code block is actually valid C, if it's been tagged as C.

Unfortunately most of our code blocks are just snippets with invalid syntax like lines of ... in between valid lines so I just disable those checks.

If you see the commit log, one commit changes this config file key since the newer version of rstcheck doesn't use that key.

The new config was picked up by the old workflow so it brings this error up.

Found a lot of non-breaking spaces in places where they were not needed.
Replace them with spaces and fix the resulting whitespace errors.

Out of curiosity I was scanning the docs for any non-ascii characters to
see if there is anything that could be breaking formatting that standard
mechanisms wouldn't catch. Found all of this. Assume it was from the
initial import from the processor wiki.

Signed-off-by: Randolph Sapp <rs@ti.com>
Use the isonum standard symbol defintions for unicode characters like
the registered sign.

Signed-off-by: Randolph Sapp <rs@ti.com>
Use isonum standard symbol definitions for the micro symbol.

Signed-off-by: Randolph Sapp <rs@ti.com>
Use standard I2C notation instead of using the unicode power of 2 symbol.

Signed-off-by: Randolph Sapp <rs@ti.com>
Use isonum standard symbol definitions for the degree sign.

Signed-off-by: Randolph Sapp <rs@ti.com>
Use ascii vertical bar instead of the unicode broken bar symbol.

Signed-off-by: Randolph Sapp <rs@ti.com>
Based on the rest of this code snippet, this character should have never
been here.

Signed-off-by: Randolph Sapp <rs@ti.com>
Fix invalid characters in csv table. An old jira ticket is using unusual
characters.

Signed-off-by: Randolph Sapp <rs@ti.com>
Now that this is fully containerized, bump all requirements to the
latest stable release.

This includes a massive rework of rstcheck that makes it capable of
parsing include and a few other sphinx directives.

Signed-off-by: Randolph Sapp <rs@ti.com>
The config for rstcheck changed slightly, it expects ignore_language to
be ignore_languages now.

Signed-off-by: Randolph Sapp <rs@ti.com>
Copy link

New warnings found with rstcheck:

[Errno 2] No such file or directory: 'g++'

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.

image

@StaticRocket
Copy link
Member Author

You know what, let me split this PR. Package upgrades should be independent of this.

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