Bugfix/lint collection #125

StaticRocket · 2024-12-15T19:40:45Z

Assorted selection of lint fixes

github-actions · 2024-12-15T19:41:44Z

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

source/linux/Industrial_Protocols/PTP/_PTP.rst

source/system/Demo_User_Guides/Servo_Drive_Demo_User_Guide.rst

cshilwant

#125 (comment)

github-actions · 2025-01-07T22:19:31Z

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 · 2025-01-07T22:25:45Z

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.

github-actions · 2025-01-08T20:44:29Z

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

cshilwant · 2025-01-30T19:10:56Z

@jeevantelukula for reviews

source/linux/Industrial_Protocols/PTP/_PTP.rst

github-actions · 2025-03-04T19:05:39Z

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:168: (INFO/1) Enumerated list start value not ordinal-1: "2" (ordinal 2)
source/linux/Industrial_Protocols/PTP/_PTP.rst:812: (INFO/1) Duplicate implicit target name: "phy delay compensation for am57xx idk".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1181: (INFO/1) Duplicate implicit target name: "hardware overview".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1191: (INFO/1) Duplicate implicit target name: "test setup/procedure".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1669: (INFO/1) Duplicate implicit target name: "limitations".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1698: (INFO/1) Duplicate implicit target name: "overview".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1725: (INFO/1) Duplicate implicit target name: "hardware".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1731: (INFO/1) Duplicate implicit target name: "software".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1787: (INFO/1) Duplicate implicit target name: "software".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1827: (INFO/1) Duplicate implicit target name: "test setup/procedure".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1856: (ERROR/3) Error in "code-block" directive:
source/linux/Industrial_Protocols/PTP/_PTP.rst:2008: (INFO/1) Duplicate implicit target name: "procedure".
source/linux/Industrial_Protocols/PTP/_PTP.rst:2019: (INFO/1) Duplicate implicit target name: "test results".
source/linux/Industrial_Protocols/PTP/_PTP.rst:2022: (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:2027: (INFO/1) Duplicate implicit target name: "test 2. without a hybrid clock between master and slave clock".
source/linux/Industrial_Protocols/PTP/_PTP.rst:2032: (INFO/1) Duplicate implicit target name: "limitations".

Address all the current possible title underline warnings. Signed-off-by: Randolph Sapp <[email protected]>

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]>

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

Address the following warning by removing the duplicate target name: Duplicate explicit target name: "backplane-configuration" Signed-off-by: Randolph Sapp <[email protected]>

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

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]>

Fix the unused directive generating the following warning: Literal block expected; none found. Signed-off-by: Randolph Sapp <[email protected]>

Address some issues with rstcheck and reword a few sections. Signed-off-by: Randolph Sapp <[email protected]>

Address the title underline warning for the omapl hardware setup guide. Signed-off-by: Randolph Sapp <[email protected]>

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]>

Remove an invalid line block that was breaking parsing. Signed-off-by: Randolph Sapp <[email protected]>

Normalize all of the code blocks in this section and re-tag them as appropriate. Signed-off-by: Randolph Sapp <[email protected]>

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]>

Signed-off-by: Randolph Sapp <[email protected]>

Replace all relative links with proper refs. Some of these links were already invalid. If any of these are wrong I'll leave it to the IP owner to sort out. Signed-off-by: Randolph Sapp <[email protected]>

github-actions · 2025-03-15T06:23:41Z

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:168: (INFO/1) Enumerated list start value not ordinal-1: "2" (ordinal 2)
source/linux/Industrial_Protocols/PTP/_PTP.rst:812: (INFO/1) Duplicate implicit target name: "phy delay compensation for am57xx idk".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1181: (INFO/1) Duplicate implicit target name: "hardware overview".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1191: (INFO/1) Duplicate implicit target name: "test setup/procedure".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1669: (INFO/1) Duplicate implicit target name: "limitations".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1698: (INFO/1) Duplicate implicit target name: "overview".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1725: (INFO/1) Duplicate implicit target name: "hardware".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1731: (INFO/1) Duplicate implicit target name: "software".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1787: (INFO/1) Duplicate implicit target name: "software".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1827: (INFO/1) Duplicate implicit target name: "test setup/procedure".
source/linux/Industrial_Protocols/PTP/_PTP.rst:1856: (ERROR/3) Error in "code-block" directive:
source/linux/Industrial_Protocols/PTP/_PTP.rst:2008: (INFO/1) Duplicate implicit target name: "procedure".
source/linux/Industrial_Protocols/PTP/_PTP.rst:2019: (INFO/1) Duplicate implicit target name: "test results".
source/linux/Industrial_Protocols/PTP/_PTP.rst:2022: (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:2027: (INFO/1) Duplicate implicit target name: "test 2. without a hybrid clock between master and slave clock".
source/linux/Industrial_Protocols/PTP/_PTP.rst:2032: (INFO/1) Duplicate implicit target name: "limitations".

StaticRocket · 2025-03-15T06:24:34Z

@cshilwant @praneethbajjuri , this is probably going to start conflicting with things soon.

StaticRocket requested review from aniket-l, cshilwant, praneethbajjuri and uditkumarti as code owners December 15, 2024 19:40

github-actions bot assigned 3V3RYONE, devarsht, jmenti, praneethbajjuri, r-vignesh, Siddharth-Vadapalli-at-TI and uditkumarti Dec 15, 2024

Siddharth-Vadapalli-at-TI reviewed Dec 16, 2024

View reviewed changes

source/linux/Industrial_Protocols/PTP/_PTP.rst Outdated Show resolved Hide resolved

Siddharth-Vadapalli-at-TI approved these changes Dec 16, 2024

View reviewed changes

cshilwant reviewed Dec 16, 2024

View reviewed changes

source/system/Demo_User_Guides/Servo_Drive_Demo_User_Guide.rst Outdated Show resolved Hide resolved

jeevantelukula previously approved these changes Dec 17, 2024

View reviewed changes

jsuhaas22 previously approved these changes Dec 17, 2024

View reviewed changes

cshilwant requested changes Dec 17, 2024

View reviewed changes

StaticRocket dismissed stale reviews from jsuhaas22 and jeevantelukula via aeaf67f January 7, 2025 22:18

StaticRocket force-pushed the bugfix/lint-collection branch from 0432a4d to aeaf67f Compare January 7, 2025 22:18

StaticRocket requested a review from VeeruPrudhvi as a code owner January 7, 2025 22:18

StaticRocket requested a review from cshilwant January 7, 2025 22:24

praneethbajjuri force-pushed the bugfix/lint-collection branch from aeaf67f to d36b4f5 Compare January 8, 2025 20:43

jeevantelukula reviewed Feb 3, 2025

View reviewed changes

source/linux/Industrial_Protocols/PTP/_PTP.rst Outdated Show resolved Hide resolved

StaticRocket force-pushed the bugfix/lint-collection branch from d36b4f5 to 465d986 Compare March 4, 2025 19:04

StaticRocket requested review from danish-ti, jeevantelukula and jsuhaas22 March 4, 2025 20:59

StaticRocket added 15 commits March 15, 2025 01:19

fix: all possible title underline warnings

ee817be

Address all the current possible title underline warnings. Signed-off-by: Randolph Sapp <[email protected]>

fix: set language for a few code-blocks

da9b473

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]>

fix: duplicate explicit target name: "user guide"

cfee368

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

fix(pcie): duplicate explicit target name

4f3f2ba

Address the following warning by removing the duplicate target name: Duplicate explicit target name: "backplane-configuration" Signed-off-by: Randolph Sapp <[email protected]>

fix: duplicate explicit target name: "setup_hsr.sh"

937ea3a

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

fix(ipc-k2x): remove unused code-block directive

c861f5b

Fix the unused directive generating the following warning: Literal block expected; none found. Signed-off-by: Randolph Sapp <[email protected]>

fix(dual-cam): address some formatting and wording

98ef729

Address some issues with rstcheck and reword a few sections. Signed-off-by: Randolph Sapp <[email protected]>

fix(omapl-hardware): title underline warning

72975a7

Address the title underline warning for the omapl hardware setup guide. Signed-off-by: Randolph Sapp <[email protected]>

fix(am57-perf): possible incomplete section title

7a906fa

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]>

fix(dsp): remove invalid line-block

19cef24

Remove an invalid line block that was breaking parsing. Signed-off-by: Randolph Sapp <[email protected]>

fix(pmic): normalize all code-blocks and re-tag

613a454

Normalize all of the code blocks in this section and re-tag them as appropriate. Signed-off-by: Randolph Sapp <[email protected]>

fix(ptp): embed the setup_hsr.sh script

f8b7834

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]>

fix(ptp): title overrun

9674eab

Signed-off-by: Randolph Sapp <[email protected]>

fix(ptp): use proper refs

aefadd9

Replace all relative links with proper refs. Some of these links were already invalid. If any of these are wrong I'll leave it to the IP owner to sort out. Signed-off-by: Randolph Sapp <[email protected]>

StaticRocket force-pushed the bugfix/lint-collection branch from 465d986 to aefadd9 Compare March 15, 2025 06:22

praneethbajjuri approved these changes Mar 15, 2025

View reviewed changes

cshilwant approved these changes Mar 15, 2025

View reviewed changes

praneethbajjuri merged commit d70fca9 into TexasInstruments:master Mar 16, 2025
2 of 3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Bugfix/lint collection #125

Bugfix/lint collection #125

Uh oh!

StaticRocket commented Dec 15, 2024 •

edited

Loading

Uh oh!

github-actions bot commented Dec 15, 2024

Uh oh!

Uh oh!

Uh oh!

cshilwant left a comment

Uh oh!

github-actions bot commented Jan 7, 2025

Uh oh!

StaticRocket commented Jan 7, 2025

Uh oh!

github-actions bot commented Jan 8, 2025

Uh oh!

cshilwant commented Jan 30, 2025

Uh oh!

Uh oh!

github-actions bot commented Mar 4, 2025

Uh oh!

github-actions bot commented Mar 15, 2025

Uh oh!

StaticRocket commented Mar 15, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

Bugfix/lint collection #125

Bugfix/lint collection #125

Uh oh!

Conversation

StaticRocket commented Dec 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 15, 2024

Uh oh!

Uh oh!

Uh oh!

cshilwant left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jan 7, 2025

Uh oh!

StaticRocket commented Jan 7, 2025

Uh oh!

github-actions bot commented Jan 8, 2025

Uh oh!

cshilwant commented Jan 30, 2025

Uh oh!

Uh oh!

github-actions bot commented Mar 4, 2025

Uh oh!

github-actions bot commented Mar 15, 2025

Uh oh!

StaticRocket commented Mar 15, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

StaticRocket commented Dec 15, 2024 •

edited

Loading