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

Conversation

StaticRocket
Copy link
Member

@StaticRocket StaticRocket commented Dec 15, 2024 •
edited
Loading

Assorted selection of lint fixes

@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".

jeevantelukula
jeevantelukula previously approved these changes Dec 17, 2024
View reviewed changes
jsuhaas22
jsuhaas22 previously approved these changes Dec 17, 2024
View reviewed changes
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)

@StaticRocket StaticRocket dismissed stale reviews from jsuhaas22 and jeevantelukula via aeaf67f January 7, 2025 22:18
@StaticRocket StaticRocket force-pushed the bugfix/lint-collection branch from 0432a4d to aeaf67f Compare January 7, 2025 22:18
@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 7, 2025

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:1854: (ERROR/3) Error in "code-block" directive:
source/linux/Industrial_Protocols/PTP/_PTP.rst:2006: (INFO/1) Duplicate implicit target name: "procedure".
source/linux/Industrial_Protocols/PTP/_PTP.rst:2017: (INFO/1) Duplicate implicit target name: "test results".
source/linux/Industrial_Protocols/PTP/_PTP.rst:2020: (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:2025: (INFO/1) Duplicate implicit target name: "test 2. without a hybrid clock between master and slave clock".
source/linux/Industrial_Protocols/PTP/_PTP.rst:2030: (INFO/1) Duplicate implicit target name: "limitations".

@StaticRocket StaticRocket requested a review from cshilwant January 7, 2025 22:24
@StaticRocket
Copy link
Member Author

Ignore that source/linux/Industrial_Protocols/PTP/_PTP.rst:1854: (ERROR/3) Error in "code-block" directive: message. Rstcheck issue with sphinx overriding the default code-block directive. It's not privy to the additional parameters I'm using here.

@StaticRocket @praneethbajjuri
fix: all possible title underline warnings
68f9698 
Address all the current possible title underline warnings.

Signed-off-by: Randolph Sapp <[email protected]>
@StaticRocket @praneethbajjuri
fix: set language for a few code-blocks
170f680 
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 @praneethbajjuri
fix: duplicate explicit target name: "user guide"
9eb8b0e 
Fix the following warning by making the affected links anonymous:
Duplicate explicit target name: "user guide".

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

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

Signed-off-by: Randolph Sapp <[email protected]>
@StaticRocket @praneethbajjuri
fix(cal): remove invalid line-blocks
f5d504a 
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 @praneethbajjuri
fix(ipc-k2x): remove unused code-block directive
09edd87 
Fix the unused directive generating the following warning:
Literal block expected; none found.

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

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

Signed-off-by: Randolph Sapp <[email protected]>
@StaticRocket @praneethbajjuri
fix(am57-perf): possible incomplete section title
354d837 
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 @praneethbajjuri
fix(dsp): remove invalid line-block
ca98c63 
Remove an invalid line block that was breaking parsing.

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

Signed-off-by: Randolph Sapp <[email protected]>
@StaticRocket @praneethbajjuri
fix(ptp): embed the setup_hsr.sh script
d36b4f5 
Embed the last archived copy of this script.

https://web.archive.org/web/20210115045653/https://processors.wiki.ti.com/images/1/18/Setup_hsr.pdf

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

github-actions bot commented Jan 8, 2025

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:1854: (ERROR/3) Error in "code-block" directive:
source/linux/Industrial_Protocols/PTP/_PTP.rst:2006: (INFO/1) Duplicate implicit target name: "procedure".
source/linux/Industrial_Protocols/PTP/_PTP.rst:2017: (INFO/1) Duplicate implicit target name: "test results".
source/linux/Industrial_Protocols/PTP/_PTP.rst:2020: (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:2025: (INFO/1) Duplicate implicit target name: "test 2. without a hybrid clock between master and slave clock".
source/linux/Industrial_Protocols/PTP/_PTP.rst:2030: (INFO/1) Duplicate implicit target name: "limitations".

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

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

@jeevantelukula jeevantelukula jeevantelukula left review comments

@jsuhaas22 jsuhaas22 jsuhaas22 left review comments

@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

@cshilwant cshilwant Awaiting requested review from cshilwant cshilwant 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.