fix(CPSW): Update the CPSW documenation with Sphinx compatibility#432
Merged
Merged
Conversation
chintan013
requested review from
StaticRocket,
VeeruPrudhvi,
aniket-l,
cshilwant,
praneethbajjuri and
uditkumarti
as code owners
github-actions
Bot
assigned
chintan013,
devarsht,
praneethbajjuri,
r-vignesh,
Siddharth-Vadapalli-at-TI and
uditkumarti
Author
|
Created a new PR instead of #410 (comment) since that got closed by mistake. @jeevantelukula I have also updated documentation with the standard tab size. Can you please review ? |
| [ 4] 0.0-120.0 sec 5.99 GBytes 429 Mbits/sec | ||
| T: 0 ( 1083) P:97 I:1000 C: 120000 Min: 8 Act: 9 Avg: 15 Max: 39 | ||
| T: 1 ( 1084) P:97 I:1500 C: 79978 Min: 8 Act: 10 Avg: 17 Max: 39 | ||
| .. code-block:: sh |
Collaborator
There was a problem hiding this comment.
@chintan013, please use 'console' instead of 'sh'.
| - create file ptp.cfg with content as below: | ||
|
|
||
| :: | ||
| .. code-block:: sh |
Collaborator
There was a problem hiding this comment.
@chintan013, please use 'text' instead of 'sh' to be consistent with previous update in the PR.
| - pass configuration file to ptp4l using "-f" option: | ||
|
|
||
| :: | ||
| .. code-block:: sh |
Collaborator
There was a problem hiding this comment.
@chintan013, please use 'console' instead of 'sh'.
| in slave mode | ||
|
|
||
| :: | ||
| .. code-block:: sh |
Collaborator
There was a problem hiding this comment.
@chintan013, please use 'console' instead of 'sh'.
| For ptp-over-L2 client, use the command | ||
|
|
||
| :: | ||
| .. code-block:: sh |
Collaborator
There was a problem hiding this comment.
@chintan013, please use 'console' instead of 'sh'.
| starts a ptp4l-over-L2 master on an EVM using hardware timestamping, | ||
|
|
||
| :: | ||
| .. code-block:: sh |
Collaborator
There was a problem hiding this comment.
@chintan013, please use 'console' instead of 'sh'.
| timestamping. | ||
|
|
||
| :: | ||
| .. code-block:: sh |
Collaborator
There was a problem hiding this comment.
@chintan013, please use 'console' instead of 'sh'.
Update the CPSW documentation to follow Sphinx conventions, note that there is no functional or content changes made. Signed-off-by: Chintan Vankar <c-vankar@ti.com>
chintan013
force-pushed
the
cpsw_doc_cleanup
branch
from
0aefddf to
0221cbe
Compare
StaticRocket
approved these changes
Aug 7, 2025
Siddharth-Vadapalli-at-TI
approved these changes
Aug 8, 2025
praneethbajjuri
approved these changes
Aug 11, 2025
cshilwant
approved these changes
Aug 11, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
9 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update the CPSW documentation to follow Sphinx conventions, note that there is no functional or content changes made.