Skip to content

Conversation

@SenWang125
Copy link
Contributor

@SenWang125 SenWang125 commented Dec 15, 2025

Add a new McASP driver configuration section in the Linux kernel Audio documentation. Additions includes the latest async-mode changes.

Also add another commit for fixing all the improper grammar and rst syntaxical issues in the Audio.rst file.
(https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-file)

@github-actions
Copy link

New warnings found with rstcheck:

source/linux/Foundational_Components/Kernel/Kernel_Drivers/Audio.rst:147: (ERROR/3) Unexpected indentation.
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Audio.rst:152: (ERROR/3) Unexpected indentation.
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Audio.rst:295: (ERROR/3) Unexpected indentation.
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Audio.rst:395: (WARNING/2) Title underline too short.
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Audio.rst:395: (WARNING/2) Title underline too short.
source/devices/J7_Family/linux/Release_Specific_Kernel_Performance_Guide.rst:829: (INFO/1) Duplicate implicit target name: "j721e-idk-gw".
source/devices/J7_Family/linux/Release_Specific_Kernel_Performance_Guide.rst:833: (INFO/1) Duplicate implicit target name: "ubifs".
source/devices/J7_Family/linux/Release_Specific_Kernel_Performance_Guide.rst:847: (INFO/1) Duplicate implicit target name: "raw".
source/devices/J7_Family/linux/Release_Specific_Kernel_Performance_Guide.rst:866: (INFO/1) Duplicate implicit target name: "ubifs".
source/devices/J7_Family/linux/Release_Specific_Kernel_Performance_Guide.rst:880: (INFO/1) Duplicate implicit target name: "raw".
source/devices/J7_Family/linux/Release_Specific_Kernel_Performance_Guide.rst:896: (INFO/1) Duplicate implicit target name: "ubifs".
source/devices/J7_Family/linux/Release_Specific_Kernel_Performance_Guide.rst:910: (INFO/1) Duplicate implicit target name: "raw".
source/devices/J7_Family/linux/Release_Specific_Kernel_Performance_Guide.rst:926: (INFO/1) Duplicate implicit target name: "ubifs".
source/devices/J7_Family/linux/Release_Specific_Kernel_Performance_Guide.rst:940: (INFO/1) Duplicate implicit target name: "raw".
source/devices/J7_Family/linux/Release_Specific_Kernel_Performance_Guide.rst:982: (INFO/1) Duplicate implicit target name: "j721e-idk-gw".
source/devices/J7_Family/linux/Release_Specific_Kernel_Performance_Guide.rst:996: (INFO/1) Duplicate implicit target name: "j721s2-evm".
source/devices/J7_Family/linux/Release_Specific_Kernel_Performance_Guide.rst:1012: (INFO/1) Duplicate implicit target name: "j742s2-evm".
source/devices/J7_Family/linux/Release_Specific_Kernel_Performance_Guide.rst:1026: (INFO/1) Duplicate implicit target name: "j784s4-evm".
source/devices/J7_Family/linux/Release_Specific_Kernel_Performance_Guide.rst:1067: (INFO/1) Duplicate implicit target name: "j721e-idk-gw".
source/devices/J7_Family/linux/Release_Specific_Kernel_Performance_Guide.rst:1082: (INFO/1) Duplicate implicit target name: "j742s2-evm".
source/devices/J7_Family/linux/Release_Specific_Kernel_Performance_Guide.rst:1095: (INFO/1) Duplicate implicit target name: "j784s4-evm".

@StaticRocket
Copy link
Member

https://github.com/TexasInstruments/processor-sdk-doc/blob/master/CONTRIBUTING.md#commit-types

@SenWang125 SenWang125 changed the title doc(linux): Add McASP configuration documentation doc(linux): Add McASP configuration documentation and grammar syntax fix for Audio.rst Dec 16, 2025
@SenWang125 SenWang125 changed the title doc(linux): Add McASP configuration documentation and grammar syntax fix for Audio.rst feat(linux): Add McASP configuration documentation and grammar syntax fix for Audio.rst Dec 16, 2025
@SenWang125
Copy link
Contributor Author

https://github.com/TexasInstruments/processor-sdk-doc/blob/master/CONTRIBUTING.md#commit-types

Reworded the commits with the proper commit types.

@github-actions
Copy link

New warnings found with rstcheck:

source/linux/Foundational_Components/Kernel/Kernel_Drivers/Audio.rst:162: (ERROR/3) Unexpected indentation.
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Audio.rst:167: (ERROR/3) Unexpected indentation.
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Audio.rst:330: (ERROR/3) Unexpected indentation.

Copy link
Contributor Author

@SenWang125 SenWang125 left a comment

Choose a reason for hiding this comment

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

Turns out all my comments were "pending" and needed to submit a review to publish my reply.

@SenWang125 SenWang125 force-pushed the McASP_async_doc branch 3 times, most recently from 4b3feb1 to e443562 Compare December 17, 2025 00:09
@github-actions
Copy link

New warnings found with rstcheck:

source/linux/Foundational_Components/Kernel/Kernel_Drivers/Audio.rst:162: (ERROR/3) Unexpected indentation.
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Audio.rst:167: (ERROR/3) Unexpected indentation.
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Audio.rst:359: (WARNING/2) Title underline too short.

@SenWang125 SenWang125 force-pushed the McASP_async_doc branch 3 times, most recently from 31401df to f94d900 Compare December 17, 2025 21:25
@SenWang125
Copy link
Contributor Author

Updated all resolved issues and rstcheck syntaxical erros. Please let me know if anything else needs to be done.

@StaticRocket
Copy link
Member

That signed-off-by in the second commit is incorrect. Trailers are case sensitive, it should be Signed-off-by.

@SenWang125
Copy link
Contributor Author

That signed-off-by in the second commit is incorrect. Trailers are case sensitive, it should be Signed-off-by.

Fixed, apologies on the typo.

SenWang125 and others added 2 commits December 18, 2025 09:53
Add a new McASP driver configuration section in the Linux kernel Audio documentation. Addintions includes the latest async-mode changes.

Signed-off-by: Sen Wang <senwang125@gmail.com>
Signed-off-by: Sen Wang <senwang125@gmail.com>
@praneethbajjuri praneethbajjuri dismissed cshilwant’s stale review December 18, 2025 22:14

addressed in newer version . overriding to pull this patch

@praneethbajjuri praneethbajjuri merged commit d1f49e6 into TexasInstruments:master Dec 18, 2025
5 of 6 checks passed
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.

9 participants