diff --git a/.github/workflows/check_toc_txt.yml b/.github/workflows/check_toc_txt.yml new file mode 100644 index 000000000..82eec08bf --- /dev/null +++ b/.github/workflows/check_toc_txt.yml @@ -0,0 +1,68 @@ +--- +name: "check_toc_txt" + +on: + pull_request: + branches: [master] + paths: + - 'source/**' + - 'configs/*/*_toc.txt' + +defaults: + run: + shell: bash + +jobs: + lint: + name: Lint + runs-on: ubuntu-latest + container: + image: ghcr.io/texasinstruments/processor-sdk-doc:latest + options: --entrypoint /bin/bash + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Update refs and settings + run: | + git config --global --add safe.directory "$PWD" + git switch -C pr + git fetch --no-tags --depth=1 origin master + git switch master + + - name: Run rstcheck + run: | + # Disable color output + export NO_COLOR=true + + # Run the test + bin/delta.sh -a master -b pr -- ./bin/check_toc_txt.py + + # Prepare summary + WARNING_COUNT=$(wc -l < _new-warn.log) + if [ "$WARNING_COUNT" -gt "0" ]; then + echo "New issues found with check_toc_txt.py:" + echo '```text' + cat _new-warn.log + echo '```' + else + echo "No new issues found with check_toc_txt.py" + fi >> "$GITHUB_STEP_SUMMARY" + + # Prepare the artifacts + mkdir -p ./results + echo "${{ github.event.number }}" > ./results/id + cp "$GITHUB_STEP_SUMMARY" ./results/summary + echo "$(wc -l < _new-warn.log)" > ./results/problem-count + + # Exit with error if there are new warnings + [ "$WARNING_COUNT" -eq "0" ] + + - name: Save results + uses: actions/upload-artifact@v4 + if: always() + with: + name: results + path: results/ + retention-days: 1 diff --git a/.github/workflows/comment.yml b/.github/workflows/comment.yml index 3b2698699..d6c08f42d 100644 --- a/.github/workflows/comment.yml +++ b/.github/workflows/comment.yml @@ -5,6 +5,7 @@ on: workflow_run: workflows: - rstcheck + - check_toc_txt types: - completed diff --git a/bin/check-configs.sh b/bin/check-configs.sh deleted file mode 100755 index c5bc117ba..000000000 --- a/bin/check-configs.sh +++ /dev/null @@ -1,13 +0,0 @@ -#!/bin/bash - -# Search for files mentioned in device toc configs that no longer exist. -# Then print what they are and where they are mentioned. - -sort -u configs/*/*_toc.txt | rg '^[^\s#]' | \ - while IFS= read -r line - do - if ! [ -e "source/${line}.rst" ]; then - echo "***" - rg -i "^\s*${line}\s*$" configs/*/*_toc.txt - fi - done diff --git a/bin/check_toc_txt.py b/bin/check_toc_txt.py new file mode 100755 index 000000000..634b4895d --- /dev/null +++ b/bin/check_toc_txt.py @@ -0,0 +1,74 @@ +#!/usr/bin/env python3 + +"""Tool to verify all files in the given toc are valid + +SPDX-License-Identifier: MIT +Copyright (C) 2025 Texas Instruments Incorporated - https://www.ti.com +""" + +import argparse +import re +from pathlib import Path +import logging + +CONFIG_PATH = Path("configs/") +SOURCE_PATH = Path("source/") +COMMENT_REGEX = re.compile(r"#.*") + +logger = logging.getLogger(__name__) + + +def is_slug(slug): + """Check to see if the given slug is valid. Assumes extension will be rst. + + :param slug: String path slug + """ + path = SOURCE_PATH.joinpath(slug + ".rst") + logging.debug("Expanded slug: %s", path) + return path.is_file() + + +def process_toc_txt(path): + """Process a single toc.txt file + + :param path: Pathlib path to toc.txt + """ + with path.open("r", encoding="utf-8") as file: + logging.debug("Processing %s", path) + for line_number, line in enumerate(file): + clean_line = COMMENT_REGEX.sub("", line).strip() + if clean_line and not is_slug(clean_line): + logging.warning("Invalid slug: %s:%i %s", path, line_number + 1, clean_line) + + +def process_all(): + """Process all toc.txt files in the config directory""" + for path in CONFIG_PATH.glob("**/*toc.txt"): + if path.is_file(): + process_toc_txt(path) + + +def main(): + """Main CLI entrypoint""" + parser = argparse.ArgumentParser( + prog="check_toc_txt.py", + description="Tool to verify all files in the given toc are valid", + ) + + parser.add_argument("-t", "--toc", type=Path) + parser.add_argument("-v", "--verbose", action="store_true") + + args = parser.parse_args() + log_level = logging.DEBUG if args.verbose else logging.INFO + logging.basicConfig(level=log_level) + + if args.toc: + if not args.toc.is_file(): + logging.critical("Invalid toc.txt file specified") + process_toc_txt(args.toc) + else: + process_all() + + +if __name__ == "__main__": + main() diff --git a/configs/AM335X/AM335X_linux_toc.txt b/configs/AM335X/AM335X_linux_toc.txt index 565cce74a..612c91178 100644 --- a/configs/AM335X/AM335X_linux_toc.txt +++ b/configs/AM335X/AM335X_linux_toc.txt @@ -91,9 +91,7 @@ linux/Foundational_Components_Virtualization linux/Foundational_Components/Virtualization/Docker linux/Foundational_Components_Machine_Learning linux/Foundational_Components/Machine_Learning/armnn -linux/Foundational_Components/Machine_Learning/tidl linux/Foundational_Components/Machine_Learning/tflite -linux/Foundational_Components/Machine_Learning/tvm linux/Foundational_Components/Graphics/index linux/Foundational_Components/Graphics/Common/Display diff --git a/configs/AM437X/AM437X_linux_toc.txt b/configs/AM437X/AM437X_linux_toc.txt index 720ef9919..552fc6b18 100644 --- a/configs/AM437X/AM437X_linux_toc.txt +++ b/configs/AM437X/AM437X_linux_toc.txt @@ -22,7 +22,6 @@ linux/Release_Specific_Yocto_layer_Configuration linux/Release_Specific_Supported_Platforms_and_Versions linux/Foundational_Components linux/Foundational_Components_U-Boot -linux/Foundational_Components/U-Boot/Release-Notes linux/Foundational_Components/U-Boot/Users-Guide linux/Foundational_Components/U-Boot/UG-General-Info linux/Foundational_Components/U-Boot/UG-DFU @@ -92,9 +91,7 @@ linux/Foundational_Components_Virtualization linux/Foundational_Components/Virtualization/Docker linux/Foundational_Components_Machine_Learning linux/Foundational_Components/Machine_Learning/armnn -linux/Foundational_Components/Machine_Learning/tidl linux/Foundational_Components/Machine_Learning/tflite -linux/Foundational_Components/Machine_Learning/tvm linux/Foundational_Components/Graphics/index linux/Foundational_Components/Graphics/Common/Display diff --git a/configs/AM57X/AM57X_linux_toc.txt b/configs/AM57X/AM57X_linux_toc.txt index c61de7e09..1369e2fa1 100644 --- a/configs/AM57X/AM57X_linux_toc.txt +++ b/configs/AM57X/AM57X_linux_toc.txt @@ -18,11 +18,9 @@ devices/AM57X/linux/Release_Specific_Release_Notes devices/AM57X/linux/Release_Specific devices/AM57X/linux/Release_Specific_Yocto_layer_Configuration devices/AM57X/linux/Release_Specific_Performance_Guide -linux/Release_Specific_Migration_Guide linux/Release_Specific_Supported_Platforms_and_Versions linux/Foundational_Components linux/Foundational_Components_U-Boot -linux/Foundational_Components/U-Boot/Release-Notes linux/Foundational_Components/U-Boot/Users-Guide linux/Foundational_Components/U-Boot/UG-General-Info linux/Foundational_Components/U-Boot/UG-DFU @@ -57,11 +55,11 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/Network/NetCP linux/Foundational_Components/Kernel/Kernel_Drivers/Network/PRUSS linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_End_Point linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Root_Complex -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_overview -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_dvfs -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_smartreflex -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_suspend_resume +linux/Foundational_Components_Power_Management +linux/Foundational_Components/Power_Management/pm_overview +linux/Foundational_Components/Power_Management/pm_dvfs +linux/Foundational_Components/Power_Management/pm_smartreflex +linux/Foundational_Components/Power_Management/pm_suspend_resume linux/Foundational_Components/Kernel/Kernel_Drivers/PWM linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI linux/Foundational_Components/Kernel/Kernel_Drivers/SPI @@ -82,7 +80,7 @@ linux/Foundational_Components/Tools/Development_Tools linux/Foundational_Components/Tools/Flash_Tools linux/Foundational_Components/Tools/Pin_Mux_Tools linux/Foundational_Components/Tools/Code_Composer_Studio -linux/Foundational_Components_PRU-ICSS_PRU_ICSSG +linux/Foundational_Components_PRU_Subsystem linux/Foundational_Components/PRU-ICSS-Linux-Drivers linux/Foundational_Components/PRU-ICSS/Linux_Drivers/RemoteProc linux/Foundational_Components/PRU-ICSS/Linux_Drivers/RPMsg diff --git a/configs/AM62LX/AM62LX_linux_toc.txt b/configs/AM62LX/AM62LX_linux_toc.txt index f1619bf20..95b38659a 100644 --- a/configs/AM62LX/AM62LX_linux_toc.txt +++ b/configs/AM62LX/AM62LX_linux_toc.txt @@ -1,5 +1,4 @@ devices/AM62LX/index -devices/AM62LX/index_RTOS devices/AM62LX/linux/Overview devices/AM62LX/linux/Overview_Getting_Started_Guide devices/AM62LX/linux/Overview/Download_and_Install_the_SDK @@ -84,7 +83,6 @@ linux/Foundational_Components_Tools linux/Foundational_Components/Tools/Development_Tools linux/Foundational_Components/Tools/Pin_Mux_Tools #linux/Foundational_Components/Tools/GPIO_Tools -linux/Foundational_Components_IPC62l linux/Foundational_Components_Machine_Learning linux/Foundational_Components/Machine_Learning/arm_compute_library linux/Foundational_Components/Machine_Learning/armnn diff --git a/configs/AM65X/AM65X_linux_toc.txt b/configs/AM65X/AM65X_linux_toc.txt index 03f702dd4..486481e0e 100644 --- a/configs/AM65X/AM65X_linux_toc.txt +++ b/configs/AM65X/AM65X_linux_toc.txt @@ -17,10 +17,8 @@ devices/AM65X/linux/Release_Specific_Yocto_layer_Configuration devices/AM65X/linux/Release_Specific_Migration_Guide devices/AM65X/linux/Release_Specific_Performance_Guide devices/AM65X/linux/Release_Specific_Supported_Platforms_and_Versions -devices/AM65X/linux/Release_Specific_QSG linux/Foundational_Components linux/Foundational_Components_U-Boot -linux/Foundational_Components/U-Boot/Release-Notes linux/Foundational_Components/U-Boot/Users-Guide linux/Foundational_Components/U-Boot/UG-General-Info linux/Foundational_Components/U-Boot/UG-DFU diff --git a/configs/AM67/AM67_linux_toc.txt b/configs/AM67/AM67_linux_toc.txt index 478587b9a..49babb5d3 100644 --- a/configs/AM67/AM67_linux_toc.txt +++ b/configs/AM67/AM67_linux_toc.txt @@ -16,10 +16,8 @@ devices/J7_Family/linux/Release_Specific_Yocto_layer_Configuration devices/J7_Family/linux/Release_Specific_Migration_Guide devices/J7_Family/linux/Release_Specific_Performance_Guide devices/J7_Family/linux/Release_Specific_Supported_Platforms_and_Versions -devices/J7_Family/linux/Release_Specific_QSG linux/Foundational_Components linux/Foundational_Components_U-Boot -linux/Foundational_Components/U-Boot/Release-Notes linux/Foundational_Components/U-Boot/Users-Guide linux/Foundational_Components/U-Boot/UG-General-Info linux/Foundational_Components/U-Boot/UG-DFU @@ -60,8 +58,8 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-CBS linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-IET linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-TSN-Tuning linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Root_Complex -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_dfs +linux/Foundational_Components_Power_Management +linux/Foundational_Components/Power_Management/pm_dfs linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI linux/Foundational_Components/Kernel/Kernel_Drivers/SERDES/SERDES linux/Foundational_Components/Kernel/Kernel_Drivers/SPI diff --git a/configs/AM67A/AM67A_linux_toc.txt b/configs/AM67A/AM67A_linux_toc.txt index bed666949..37c856a45 100644 --- a/configs/AM67A/AM67A_linux_toc.txt +++ b/configs/AM67A/AM67A_linux_toc.txt @@ -16,11 +16,9 @@ devices/J7_Family/linux/Release_Specific_Yocto_layer_Configuration devices/J7_Family/linux/Release_Specific_Migration_Guide devices/J7_Family/linux/Release_Specific_Performance_Guide devices/J7_Family/linux/Release_Specific_Supported_Platforms_and_Versions -devices/J7_Family/linux/Release_Specific_QSG linux/Foundational_Components linux/index_Edge_AI linux/Foundational_Components_U-Boot -linux/Foundational_Components/U-Boot/Release-Notes linux/Foundational_Components/U-Boot/Users-Guide linux/Foundational_Components/U-Boot/UG-General-Info linux/Foundational_Components/U-Boot/UG-DFU @@ -61,8 +59,8 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-CBS linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-IET linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-TSN-Tuning linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Root_Complex -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_dfs +linux/Foundational_Components_Power_Management +linux/Foundational_Components/Power_Management/pm_dfs linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI linux/Foundational_Components/Kernel/Kernel_Drivers/SERDES/SERDES linux/Foundational_Components/Kernel/Kernel_Drivers/SPI @@ -86,7 +84,6 @@ linux/Foundational_Components_Virtualization linux/Foundational_Components/Virtualization/Docker linux/Foundational_Components_OPTEE linux/Foundational_Components_ATF -linux/Foundational_Components_Multimedia_Other_Tools linux/Foundational_Components_Multimedia_wave5 linux/Foundational_Components/Graphics/index linux/Foundational_Components/Graphics/Common/Display diff --git a/configs/AM68/AM68_linux_toc.txt b/configs/AM68/AM68_linux_toc.txt index 86a241519..81843b1a7 100644 --- a/configs/AM68/AM68_linux_toc.txt +++ b/configs/AM68/AM68_linux_toc.txt @@ -16,10 +16,8 @@ devices/J7_Family/linux/Release_Specific_Yocto_layer_Configuration devices/J7_Family/linux/Release_Specific_Migration_Guide devices/J7_Family/linux/Release_Specific_Performance_Guide devices/J7_Family/linux/Release_Specific_Supported_Platforms_and_Versions -devices/J7_Family/linux/Release_Specific_QSG linux/Foundational_Components linux/Foundational_Components_U-Boot -linux/Foundational_Components/U-Boot/Release-Notes linux/Foundational_Components/U-Boot/Users-Guide linux/Foundational_Components/U-Boot/UG-General-Info linux/Foundational_Components/U-Boot/UG-DFU @@ -65,8 +63,8 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_End_Point linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Backplane linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Root_Complex linux/Foundational_Components/Kernel/Kernel_Drivers/PMIC/pmic_tps6594 -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_dfs +linux/Foundational_Components_Power_Management +linux/Foundational_Components/Power_Management/pm_dfs linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI linux/Foundational_Components/Kernel/Kernel_Drivers/SERDES/SERDES linux/Foundational_Components/Kernel/Kernel_Drivers/SPI diff --git a/configs/AM68A/AM68A_linux_toc.txt b/configs/AM68A/AM68A_linux_toc.txt index 60a7819c9..ad98bd33d 100644 --- a/configs/AM68A/AM68A_linux_toc.txt +++ b/configs/AM68A/AM68A_linux_toc.txt @@ -16,11 +16,9 @@ devices/J7_Family/linux/Release_Specific_Yocto_layer_Configuration devices/J7_Family/linux/Release_Specific_Migration_Guide devices/J7_Family/linux/Release_Specific_Performance_Guide devices/J7_Family/linux/Release_Specific_Supported_Platforms_and_Versions -devices/J7_Family/linux/Release_Specific_QSG linux/Foundational_Components linux/index_Edge_AI linux/Foundational_Components_U-Boot -linux/Foundational_Components/U-Boot/Release-Notes linux/Foundational_Components/U-Boot/Users-Guide linux/Foundational_Components/U-Boot/UG-General-Info linux/Foundational_Components/U-Boot/UG-DFU @@ -66,8 +64,8 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_End_Point linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Backplane linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Root_Complex linux/Foundational_Components/Kernel/Kernel_Drivers/PMIC/pmic_tps6594 -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_dfs +linux/Foundational_Components_Power_Management +linux/Foundational_Components/Power_Management/pm_dfs linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI linux/Foundational_Components/Kernel/Kernel_Drivers/SERDES/SERDES linux/Foundational_Components/Kernel/Kernel_Drivers/SPI @@ -128,7 +126,7 @@ linux/How_to_Guides/FAQ/How_to_Integrate_Open_Source_Software linux/How_to_Guides/Host/How_to_Build_a_Ubuntu_Linux_host_under_VMware linux/How_to_Guides_Hardware_Setup_with_CCS linux/How_to_Guides/Hardware_Setup_with_CCS/AM68_SK_Hardware_Setup -linux/How_to_Guides/Target/How_To_Carve_out_CMA +linux/How_to_Guides/Target/How_To_Carve_Out_CMA linux/Documentation_Tarball diff --git a/configs/AM69/AM69_linux_toc.txt b/configs/AM69/AM69_linux_toc.txt index 60ca0d2c9..74e630842 100644 --- a/configs/AM69/AM69_linux_toc.txt +++ b/configs/AM69/AM69_linux_toc.txt @@ -16,10 +16,8 @@ devices/J7_Family/linux/Release_Specific_Yocto_layer_Configuration devices/J7_Family/linux/Release_Specific_Migration_Guide devices/J7_Family/linux/Release_Specific_Performance_Guide devices/J7_Family/linux/Release_Specific_Supported_Platforms_and_Versions -devices/J7_Family/linux/Release_Specific_QSG linux/Foundational_Components linux/Foundational_Components_U-Boot -linux/Foundational_Components/U-Boot/Release-Notes linux/Foundational_Components/U-Boot/Users-Guide linux/Foundational_Components/U-Boot/UG-General-Info linux/Foundational_Components/U-Boot/UG-DFU @@ -65,8 +63,8 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_End_Point linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Backplane linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Root_Complex linux/Foundational_Components/Kernel/Kernel_Drivers/PMIC/pmic_tps6594 -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_dfs +linux/Foundational_Components_Power_Management +linux/Foundational_Components/Power_Management/pm_dfs linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI linux/Foundational_Components/Kernel/Kernel_Drivers/SERDES/SERDES linux/Foundational_Components/Kernel/Kernel_Drivers/SPI diff --git a/configs/AM69A/AM69A_linux_toc.txt b/configs/AM69A/AM69A_linux_toc.txt index 2138d5879..f3bae318e 100644 --- a/configs/AM69A/AM69A_linux_toc.txt +++ b/configs/AM69A/AM69A_linux_toc.txt @@ -16,11 +16,9 @@ devices/J7_Family/linux/Release_Specific_Yocto_layer_Configuration devices/J7_Family/linux/Release_Specific_Migration_Guide devices/J7_Family/linux/Release_Specific_Performance_Guide devices/J7_Family/linux/Release_Specific_Supported_Platforms_and_Versions -devices/J7_Family/linux/Release_Specific_QSG linux/Foundational_Components linux/index_Edge_AI linux/Foundational_Components_U-Boot -linux/Foundational_Components/U-Boot/Release-Notes linux/Foundational_Components/U-Boot/Users-Guide linux/Foundational_Components/U-Boot/UG-General-Info linux/Foundational_Components/U-Boot/UG-DFU @@ -66,8 +64,8 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_End_Point linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Backplane linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Root_Complex linux/Foundational_Components/Kernel/Kernel_Drivers/PMIC/pmic_tps6594 -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_dfs +linux/Foundational_Components_Power_Management +linux/Foundational_Components/Power_Management/pm_dfs linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI linux/Foundational_Components/Kernel/Kernel_Drivers/SERDES/SERDES linux/Foundational_Components/Kernel/Kernel_Drivers/SPI @@ -92,7 +90,6 @@ linux/Foundational_Components_Virtualization linux/Foundational_Components/Virtualization/Docker linux/Foundational_Components_OPTEE linux/Foundational_Components_ATF -linux/Foundational_Components_Multimedia_Other_Tools linux/Foundational_Components_Multimedia_wave5 linux/Foundational_Components/Graphics/index linux/Foundational_Components/Graphics/Common/Display diff --git a/configs/CORESDK/CORESDK_linux_toc.txt b/configs/CORESDK/CORESDK_linux_toc.txt index 2b467a7f7..d5aa499a0 100644 --- a/configs/CORESDK/CORESDK_linux_toc.txt +++ b/configs/CORESDK/CORESDK_linux_toc.txt @@ -1,6 +1,5 @@ linux/index linux/Release_Specific linux/Release_Specific_CoreSDK_Release_Notes -linux/Release_Specific_CoreSDK_Performance_Guide linux/Release_Specific_CoreSDK_Yocto_layer_Configuration linux/Release_Specific_CoreSDK_Migration_Guide diff --git a/configs/DRA821A/DRA821A_linux_toc.txt b/configs/DRA821A/DRA821A_linux_toc.txt index 516c49858..c2fb6a7bc 100644 --- a/configs/DRA821A/DRA821A_linux_toc.txt +++ b/configs/DRA821A/DRA821A_linux_toc.txt @@ -15,10 +15,8 @@ devices/DRA821A/linux/Release_Specific devices/DRA821A/linux/Release_Specific_Release_Notes devices/DRA821A/linux/Release_Specific_Yocto_layer_Configuration devices/DRA821A/linux/Release_Specific_Supported_Platforms_and_Versions -devices/DRA821A/linux/Release_Specific_QSG linux/Foundational_Components linux/Foundational_Components_U-Boot -linux/Foundational_Components/U-Boot/Release-Notes linux/Foundational_Components/U-Boot/Users-Guide linux/Foundational_Components/U-Boot/UG-General-Info linux/Foundational_Components/U-Boot/UG-DFU @@ -45,7 +43,7 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/MCAN linux/Foundational_Components/Kernel/Kernel_Drivers/GPIO linux/Foundational_Components/Kernel/Kernel_Drivers/I2C linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW2g -linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-TSN-Testing +linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-TSN linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-PTP linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-EST linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-CBS @@ -70,7 +68,6 @@ linux/Foundational_Components/Tools/Development_Tools linux/Foundational_Components/Tools/Flash_Tools linux/Foundational_Components/Tools/Pin_Mux_Tools linux/Foundational_Components/Tools/Code_Composer_Studio -linux/Foundational_Components/PRU-ICSS-Linux-User-Space linux/Foundational_Components_OPTEE linux/Foundational_Components_ATF linux/How_to_Guides diff --git a/configs/GEN/GEN_android_toc.txt b/configs/GEN/GEN_android_toc.txt index f3af613f9..e739886e6 100644 --- a/configs/GEN/GEN_android_toc.txt +++ b/configs/GEN/GEN_android_toc.txt @@ -1,17 +1,5 @@ android/index android/Overview android/Overview_Getting_Started_Guide -android/Overview_Directory_Structure android/Overview_Building_the_SDK -android/Overview_Software_Stack android/Overview_Technical_Support -android/Overview_GPLv3_Disclaimer -android/Release_Specific -android/Release_Specific_Release_Notes -android/Release_Specific_Supported_Platforms_and_Versions -android/Release_Specific_Migration_Guide -android/How_To_Guides -android/How_To_Guides_Load_and_Debug_APKs -android/How_To_Guides_Enable_the_PRU_Ethernet_Ports -android/How_To_Guides_Frequently_Asked_Question -android/Documentation_Tarball diff --git a/configs/GEN/GEN_linux_toc.txt b/configs/GEN/GEN_linux_toc.txt index 38f1a1afb..0db43c7ed 100644 --- a/configs/GEN/GEN_linux_toc.txt +++ b/configs/GEN/GEN_linux_toc.txt @@ -19,11 +19,9 @@ linux/Release_Specific linux/Release_Specific_PLSDK_Release_Notes linux/Release_Specific_Performance_Guide linux/Release_Specific_Yocto_layer_Configuration -linux/Release_Specific_Migration_Guide linux/Release_Specific_Supported_Platforms_and_Versions linux/Foundational_Components linux/Foundational_Components_U-Boot -linux/Foundational_Components/U-Boot/Release-Notes linux/Foundational_Components/U-Boot/Users-Guide linux/Foundational_Components/U-Boot/UG-General-Info linux/Foundational_Components/U-Boot/UG-DFU @@ -64,10 +62,11 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/Network/PRUSS linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW2g linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_End_Point linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Root_Complex -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_overview -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_dvfs -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_smartreflex -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_suspend_resume +linux/Foundational_Components_Power_Management +linux/Foundational_Components/Power_Management/pm_overview +linux/Foundational_Components/Power_Management/pm_dvfs +linux/Foundational_Components/Power_Management/pm_smartreflex +linux/Foundational_Components/Power_Management/pm_suspend_resume linux/Foundational_Components/Kernel/Kernel_Drivers/PWM linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI linux/Foundational_Components/Kernel/Kernel_Drivers/SPI @@ -113,10 +112,8 @@ linux/Foundational_Components_OpenVX linux/Foundational_Components_Virtualization linux/Foundational_Components/Virtualization/Docker linux/Foundational_Components_Machine_Learning -linux/Foundational_Components/Machine_Learning/tidl linux/Foundational_Components/Machine_Learning/armnn linux/Foundational_Components/Machine_Learning/tflite -linux/Foundational_Components/Machine_Learning/tvm linux/Foundational_Components_OPTEE linux/Foundational_Components_ATF diff --git a/configs/J7200/J7200_linux_toc.txt b/configs/J7200/J7200_linux_toc.txt index ff3a4910a..82f4e6064 100644 --- a/configs/J7200/J7200_linux_toc.txt +++ b/configs/J7200/J7200_linux_toc.txt @@ -17,10 +17,8 @@ devices/J7_Family/linux/Release_Specific_Yocto_layer_Configuration devices/J7_Family/linux/Release_Specific_Migration_Guide devices/J7_Family/linux/Release_Specific_Performance_Guide devices/J7_Family/linux/Release_Specific_Supported_Platforms_and_Versions -devices/J7_Family/linux/Release_Specific_QSG linux/Foundational_Components linux/Foundational_Components_U-Boot -linux/Foundational_Components/U-Boot/Release-Notes linux/Foundational_Components/U-Boot/Users-Guide linux/Foundational_Components/U-Boot/UG-General-Info linux/Foundational_Components/U-Boot/UG-DFU @@ -63,8 +61,8 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-TSN-Tuning linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_End_Point linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Root_Complex linux/Foundational_Components/Kernel/Kernel_Drivers/PMIC/pmic_tps6594 -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_dfs +linux/Foundational_Components_Power_Management +linux/Foundational_Components/Power_Management/pm_dfs linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI linux/Foundational_Components/Kernel/Kernel_Drivers/SERDES/SERDES linux/Foundational_Components/Kernel/Kernel_Drivers/SPI @@ -84,7 +82,6 @@ linux/Foundational_Components/Tools/Development_Tools linux/Foundational_Components/Tools/Flash_Tools linux/Foundational_Components/Tools/SysConfig_Tools linux/Foundational_Components/Tools/Code_Composer_Studio -linux/Foundational_Components/PRU-ICSS-Linux-User-Space linux/Foundational_Components_IPC_J7200 linux/Foundational_Components_OPTEE linux/Foundational_Components_ATF diff --git a/configs/J721E/J721E_android_toc.txt b/configs/J721E/J721E_android_toc.txt index f3af613f9..e739886e6 100644 --- a/configs/J721E/J721E_android_toc.txt +++ b/configs/J721E/J721E_android_toc.txt @@ -1,17 +1,5 @@ android/index android/Overview android/Overview_Getting_Started_Guide -android/Overview_Directory_Structure android/Overview_Building_the_SDK -android/Overview_Software_Stack android/Overview_Technical_Support -android/Overview_GPLv3_Disclaimer -android/Release_Specific -android/Release_Specific_Release_Notes -android/Release_Specific_Supported_Platforms_and_Versions -android/Release_Specific_Migration_Guide -android/How_To_Guides -android/How_To_Guides_Load_and_Debug_APKs -android/How_To_Guides_Enable_the_PRU_Ethernet_Ports -android/How_To_Guides_Frequently_Asked_Question -android/Documentation_Tarball diff --git a/configs/J721E/J721E_linux_toc.txt b/configs/J721E/J721E_linux_toc.txt index 6ac97d0af..51c673fa2 100644 --- a/configs/J721E/J721E_linux_toc.txt +++ b/configs/J721E/J721E_linux_toc.txt @@ -17,10 +17,8 @@ devices/J7_Family/linux/Release_Specific_Yocto_layer_Configuration devices/J7_Family/linux/Release_Specific_Migration_Guide devices/J7_Family/linux/Release_Specific_Performance_Guide devices/J7_Family/linux/Release_Specific_Supported_Platforms_and_Versions -devices/J7_Family/linux/Release_Specific_QSG linux/Foundational_Components linux/Foundational_Components_U-Boot -linux/Foundational_Components/U-Boot/Release-Notes linux/Foundational_Components/U-Boot/Users-Guide linux/Foundational_Components/U-Boot/UG-General-Info linux/Foundational_Components/U-Boot/UG-DFU @@ -68,8 +66,8 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_End_Point linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Backplane linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Root_Complex linux/Foundational_Components/Kernel/Kernel_Drivers/PMIC/pmic_tps6594 -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_dfs +linux/Foundational_Components_Power_Management +linux/Foundational_Components/Power_Management/pm_dfs linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI linux/Foundational_Components/Kernel/Kernel_Drivers/SERDES/SERDES linux/Foundational_Components/Kernel/Kernel_Drivers/SPI diff --git a/configs/J721S2/J721S2_linux_toc.txt b/configs/J721S2/J721S2_linux_toc.txt index ad42cc0c8..ae30aaf65 100644 --- a/configs/J721S2/J721S2_linux_toc.txt +++ b/configs/J721S2/J721S2_linux_toc.txt @@ -17,10 +17,8 @@ devices/J7_Family/linux/Release_Specific_Yocto_layer_Configuration devices/J7_Family/linux/Release_Specific_Migration_Guide devices/J7_Family/linux/Release_Specific_Performance_Guide devices/J7_Family/linux/Release_Specific_Supported_Platforms_and_Versions -devices/J7_Family/linux/Release_Specific_QSG linux/Foundational_Components linux/Foundational_Components_U-Boot -linux/Foundational_Components/U-Boot/Release-Notes linux/Foundational_Components/U-Boot/Users-Guide linux/Foundational_Components/U-Boot/UG-General-Info linux/Foundational_Components/U-Boot/UG-DFU @@ -68,8 +66,8 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_End_Point linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Backplane linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Root_Complex linux/Foundational_Components/Kernel/Kernel_Drivers/PMIC/pmic_tps6594 -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_dfs +linux/Foundational_Components_Power_Management +linux/Foundational_Components/Power_Management/pm_dfs linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI linux/Foundational_Components/Kernel/Kernel_Drivers/SERDES/SERDES linux/Foundational_Components/Kernel/Kernel_Drivers/SPI diff --git a/configs/J722S/J722S_linux_toc.txt b/configs/J722S/J722S_linux_toc.txt index 9e48654dd..1bcef2e1c 100644 --- a/configs/J722S/J722S_linux_toc.txt +++ b/configs/J722S/J722S_linux_toc.txt @@ -17,10 +17,8 @@ devices/J7_Family/linux/Release_Specific_Yocto_layer_Configuration devices/J7_Family/linux/Release_Specific_Migration_Guide devices/J7_Family/linux/Release_Specific_Performance_Guide devices/J7_Family/linux/Release_Specific_Supported_Platforms_and_Versions -devices/J7_Family/linux/Release_Specific_QSG linux/Foundational_Components linux/Foundational_Components_U-Boot -linux/Foundational_Components/U-Boot/Release-Notes linux/Foundational_Components/U-Boot/Users-Guide linux/Foundational_Components/U-Boot/UG-General-Info linux/Foundational_Components/U-Boot/UG-DFU @@ -63,8 +61,8 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-CBS linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-IET linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-TSN-Tuning linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Root_Complex -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_dfs +linux/Foundational_Components_Power_Management +linux/Foundational_Components/Power_Management/pm_dfs linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI linux/Foundational_Components/Kernel/Kernel_Drivers/SERDES/SERDES linux/Foundational_Components/Kernel/Kernel_Drivers/SPI diff --git a/configs/J742S2/J742S2_linux_toc.txt b/configs/J742S2/J742S2_linux_toc.txt index 5c82e1cc6..6b96a50f1 100644 --- a/configs/J742S2/J742S2_linux_toc.txt +++ b/configs/J742S2/J742S2_linux_toc.txt @@ -17,10 +17,8 @@ devices/J7_Family/linux/Release_Specific_Yocto_layer_Configuration devices/J7_Family/linux/Release_Specific_Migration_Guide devices/J7_Family/linux/Release_Specific_Performance_Guide devices/J7_Family/linux/Release_Specific_Supported_Platforms_and_Versions -devices/J7_Family/linux/Release_Specific_QSG linux/Foundational_Components linux/Foundational_Components_U-Boot -linux/Foundational_Components/U-Boot/Release-Notes linux/Foundational_Components/U-Boot/Users-Guide linux/Foundational_Components/U-Boot/UG-General-Info linux/Foundational_Components/U-Boot/UG-DFU @@ -67,8 +65,8 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_End_Point linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Backplane linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Root_Complex linux/Foundational_Components/Kernel/Kernel_Drivers/PMIC/pmic_tps6594 -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_dfs +linux/Foundational_Components_Power_Management +linux/Foundational_Components/Power_Management/pm_dfs linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI linux/Foundational_Components/Kernel/Kernel_Drivers/SERDES/SERDES linux/Foundational_Components/Kernel/Kernel_Drivers/SPI diff --git a/configs/J784S4/J784S4_linux_toc.txt b/configs/J784S4/J784S4_linux_toc.txt index d31344433..68bcc3da5 100644 --- a/configs/J784S4/J784S4_linux_toc.txt +++ b/configs/J784S4/J784S4_linux_toc.txt @@ -17,10 +17,8 @@ devices/J7_Family/linux/Release_Specific_Yocto_layer_Configuration devices/J7_Family/linux/Release_Specific_Migration_Guide devices/J7_Family/linux/Release_Specific_Performance_Guide devices/J7_Family/linux/Release_Specific_Supported_Platforms_and_Versions -devices/J7_Family/linux/Release_Specific_QSG linux/Foundational_Components linux/Foundational_Components_U-Boot -linux/Foundational_Components/U-Boot/Release-Notes linux/Foundational_Components/U-Boot/Users-Guide linux/Foundational_Components/U-Boot/UG-General-Info linux/Foundational_Components/U-Boot/UG-DFU @@ -68,8 +66,8 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_End_Point linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Backplane linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Root_Complex linux/Foundational_Components/Kernel/Kernel_Drivers/PMIC/pmic_tps6594 -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_dfs +linux/Foundational_Components_Power_Management +linux/Foundational_Components/Power_Management/pm_dfs linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI linux/Foundational_Components/Kernel/Kernel_Drivers/SERDES/SERDES linux/Foundational_Components/Kernel/Kernel_Drivers/SPI @@ -134,7 +132,7 @@ linux/How_to_Guides/FAQ/How_to_Integrate_Open_Source_Software linux/How_to_Guides/Host/How_to_Build_a_Ubuntu_Linux_host_under_VMware linux/How_to_Guides_Hardware_Setup_with_CCS linux/How_to_Guides/Hardware_Setup_with_CCS/J784S4_EVM_Hardware_Setup -linux/How_to_Guides/Hardware_Setup_with_CCS/AM69_SK_EVM_Hardware_Setup +linux/How_to_Guides/Hardware_Setup_with_CCS/AM69_SK_Hardware_Setup linux/How_to_Guides/FAQ/How_to_run_BIST_on_a_core linux/How_to_Guides/Target/How_To_Carve_Out_CMA linux/Documentation_Tarball diff --git a/configs/TDA4VM/TDA4VM_linux_toc.txt b/configs/TDA4VM/TDA4VM_linux_toc.txt index 4b5457bac..82bfc082b 100644 --- a/configs/TDA4VM/TDA4VM_linux_toc.txt +++ b/configs/TDA4VM/TDA4VM_linux_toc.txt @@ -17,11 +17,9 @@ devices/J7_Family/linux/Release_Specific_Yocto_layer_Configuration devices/J7_Family/linux/Release_Specific_Migration_Guide devices/J7_Family/linux/Release_Specific_Performance_Guide devices/J7_Family/linux/Release_Specific_Supported_Platforms_and_Versions -devices/J7_Family/linux/Release_Specific_QSG linux/Foundational_Components linux/index_Edge_AI linux/Foundational_Components_U-Boot -linux/Foundational_Components/U-Boot/Release-Notes linux/Foundational_Components/U-Boot/Users-Guide linux/Foundational_Components/U-Boot/UG-General-Info linux/Foundational_Components/U-Boot/UG-DFU @@ -68,9 +66,8 @@ linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_End_Point linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Backplane linux/Foundational_Components/Kernel/Kernel_Drivers/PCIe/PCIe_Root_Complex linux/Foundational_Components/Kernel/Kernel_Drivers/PMIC/pmic_tps6594 -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management -linux/Foundational_Components/Kernel/Kernel_Drivers/Power_Management/pm_dfs -linux/Foundational_Components_Kernel_Drivers_Power_Management +linux/Foundational_Components_Power_Management +linux/Foundational_Components/Power_Management/pm_dfs linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI linux/Foundational_Components/Kernel/Kernel_Drivers/SERDES/SERDES linux/Foundational_Components/Kernel/Kernel_Drivers/SPI @@ -92,9 +89,9 @@ linux/Foundational_Components/Tools/Pin_Mux_Tools linux/Foundational_Components/Tools/Code_Composer_Studio linux/Foundational_Components_IPC_J721E linux/Foundational_Components/Graphics/index -linux/Foundational_Components/Graphics/Graphics_and_Display -linux/Foundational_Components/Graphics/Rogue_Debug_Info -linux/Foundational_Components/Graphics/Rogue_Power_Management_Info +linux/Foundational_Components/Graphics/Common/Display +linux/Foundational_Components/Graphics/Rogue/Rogue_Debug_Info +linux/Foundational_Components/Graphics/Rogue/Rogue_Power_Management_Info linux/Foundational_Components_Virtualization linux/Foundational_Components/Virtualization/Docker linux/Foundational_Components_OPTEE @@ -126,4 +123,3 @@ linux/Documentation_Tarball linux/Demo_User_Guides/index_Demos linux/Demo_User_Guides/Edge_AI_Gallery_User_Guide -system/Demo_User_Guides/WiFi_OOB_Demo_User_Guide