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.

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

Bugfix/lint collection #125

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

Bugfix/lint collection #125

wants to merge 13 commits into from
+273 −256

Conversation

StaticRocket
Copy link
Member

@StaticRocket StaticRocket commented Dec 15, 2024 •
edited
Loading

Assorted selection of lint fixes

@StaticRocket
fix: all possible title underline warnings
b1c12a5 
Address all the current possible title underline warnings.

Signed-off-by: Randolph Sapp <[email protected]>
@StaticRocket
fix: set language for a few code-blocks
f7cf18f 
Fix and tag the code-blocks to cut down on parsing and attribute errors.
Also, it adds syntax highlighting and some rudimentary syntax checking
for these examples.

Signed-off-by: Randolph Sapp <[email protected]>
@StaticRocket
fix: duplicate explicit target name: "user guide"
7696278 
Fix the following warning by making the affected links anonymous:
Duplicate explicit target name: "user guide".

Signed-off-by: Randolph Sapp <[email protected]>
@StaticRocket
fix(pcie): duplicate explicit target name
0f6368d 
Address the following warning by removing the duplicate target name:
Duplicate explicit target name: "backplane-configuration"

Signed-off-by: Randolph Sapp <[email protected]>
@StaticRocket
fix: duplicate explicit target name: "tmdsfsiadapevm"
881251f 
Address the following warning by making links anonymous:
Duplicate explicit target name: "tmdsfsiadapevm"

Signed-off-by: Randolph Sapp <[email protected]>
@StaticRocket
fix: duplicate explicit target name: "setup_hsr.sh"
24aa6b7 
Fix the following warning by using anonymous links:
Duplicate explicit target name: "setup_hsr.sh"

Signed-off-by: Randolph Sapp <[email protected]>
@StaticRocket
fix(cal): remove invalid line-blocks
1b51334 
Remove the line-blocks that were breaking list parsing rules:
(WARNING/2) Bullet list ends without a blank line; unexpected unindent.
(WARNING/2) Line block ends without a blank line.
(WARNING/2) Bullet list ends without a blank line; unexpected unindent.
(WARNING/2) Line block ends without a blank line.

Signed-off-by: Randolph Sapp <[email protected]>
@StaticRocket
fix(ipc-k2x): remove unused code-block directive
223e546 
Fix the unused directive generating the following warning:
Literal block expected; none found.

Signed-off-by: Randolph Sapp <[email protected]>
@StaticRocket
fix(dual-cam): address some formatting and wording
022a3ce 
Address some issues with rstcheck and reword a few sections.

Signed-off-by: Randolph Sapp <[email protected]>
@StaticRocket
fix(omapl-hardware): title underline warning
1801da5 
Address the title underline warning for the omapl hardware setup guide.

Signed-off-by: Randolph Sapp <[email protected]>
@StaticRocket
fix(am57-perf): possible incomplete section title
56938d5 
Address the following warnings:

(INFO/1) Possible incomplete section title.
(INFO/1) Blank line missing before literal block (after the "::")? Interpreted as a definition list item.

Signed-off-by: Randolph Sapp <[email protected]>
@StaticRocket
fix(dsp): remove invalid line-block
7199774 
Remove an invalid line block that was breaking parsing.

Signed-off-by: Randolph Sapp <[email protected]>
@StaticRocket
fix(pmic): normalize all code-blocks and re-tag
0432a4d 
Normalize all of the code blocks in this section and re-tag them as
appropriate.

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

New warnings found with rstcheck:

source/linux/Industrial_Protocols_PTP.rst:5: (INFO/1) Enumerated list start value not ordinal-1: "2" (ordinal 2)
source/linux/Industrial_Protocols/PTP/_PTP.rst:169: (INFO/1) Enumerated list start value not ordinal-1: "2" (ordinal 2)
source/linux/Industrial_Protocols/PTP/_PTP.rst:265: (INFO/1) Duplicate implicit target name: "gmac".
source/linux/Industrial_Protocols/PTP/_PTP.rst:810: (INFO/1) Duplicate implicit target name: "phy delay compensation for am57xx idk".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1179: (INFO/1) Duplicate implicit target name: "hardware overview".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1189: (INFO/1) Duplicate implicit target name: "test setup/procedure".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1667: (INFO/1) Duplicate implicit target name: "limitations".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1696: (INFO/1) Duplicate implicit target name: "overview".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1723: (INFO/1) Duplicate implicit target name: "hardware".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1729: (INFO/1) Duplicate implicit target name: "software".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1785: (INFO/1) Duplicate implicit target name: "software".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1825: (INFO/1) Duplicate implicit target name: "test setup/procedure".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1964: (INFO/1) Duplicate implicit target name: "procedure".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1975: (INFO/1) Duplicate implicit target name: "test results".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1978: (INFO/1) Duplicate implicit target name: "test 1. with a hybrid clock (oc+tc) between master and slave clock".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1983: (INFO/1) Duplicate implicit target name: "test 2. without a hybrid clock between master and slave clock".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1988: (INFO/1) Duplicate implicit target name: "limitations".

Siddharth-Vadapalli-at-TI
Siddharth-Vadapalli-at-TI reviewed Dec 16, 2024
View reviewed changes
source/linux/Industrial_Protocols/PTP/_PTP.rst
@@ -1847,7 +1847,7 @@ Procedure
~~~~~~~~~

The script file
`setup\_hsr.sh <http://processors.wiki.ti.com/images/1/18/Setup_hsr.pdf>`_
`setup\_hsr.sh <http://processors.wiki.ti.com/images/1/18/Setup_hsr.pdf>`__
Copy link
Collaborator

Choose a reason for hiding this comment

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

@StaticRocket, while unrelated to this PR, this link does not work anymore. @danish-ti, could you please identify the equivalent for this link and create a PR to fix the link?

Copy link
Contributor

Choose a reason for hiding this comment

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

@Siddharth-Vadapalli-at-TI I don't think there is any equivalent for this link. To fix this script will need to be hosted somewhere and link to that should be added here. But as @cshilwant mentioned that this file is not used by any device, I think dropping this is the best option.

Copy link
Member

Choose a reason for hiding this comment

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

@danish-ti I was only referring to source/system/Demo_User_Guides/Servo_Drive_Demo_User_Guide.rst file to @StaticRocket - #125 (comment)

Not sure about source/linux/Industrial_Protocols/PTP/_PTP.rst

cshilwant
cshilwant reviewed Dec 16, 2024
View reviewed changes
source/system/Demo_User_Guides/Servo_Drive_Demo_User_Guide.rst
Copy link
Member

Choose a reason for hiding this comment

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

@StaticRocket Apparently this file isn't used in any device & hence I have dropped it in #128

Copy link
Member Author

Choose a reason for hiding this comment

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

Roger. Will drop in rebase when we get info on #125 (comment)

cshilwant
cshilwant requested changes Dec 17, 2024
View reviewed changes
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.

#125 (comment)

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

@danish-ti danish-ti danish-ti left review comments

@cshilwant cshilwant cshilwant requested changes

@jeevantelukula jeevantelukula jeevantelukula approved these changes

@Siddharth-Vadapalli-at-TI Siddharth-Vadapalli-at-TI Siddharth-Vadapalli-at-TI approved these changes

@jsuhaas22 jsuhaas22 jsuhaas22 approved these changes

@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

Requested changes must be addressed to merge this pull request.

Assignees

@praneethbajjuri praneethbajjuri

@devarsht devarsht

@r-vignesh r-vignesh

@3V3RYONE 3V3RYONE

@uditkumarti uditkumarti

@Siddharth-Vadapalli-at-TI Siddharth-Vadapalli-at-TI

@jmenti jmenti

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.