Skip to content

fix(CPSW): Update the CPSW documenation with Sphinx compatibility#410

Closed
chintan013 wants to merge 1 commit into
TexasInstruments:masterfrom
chintan013:cpsw_format
Closed

fix(CPSW): Update the CPSW documenation with Sphinx compatibility#410
chintan013 wants to merge 1 commit into
TexasInstruments:masterfrom
chintan013:cpsw_format

Conversation

@chintan013

Copy link
Copy Markdown

Update the CPSW documentation to follow Sphinx conventions, note that there is no functional or content changes made.

::
.. code:: console

#!/bin/sh

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
#!/bin/sh
#!/bin/sh

I see many references in this PR with improper indentation. Make sure to maintain the indentation of 3 spaces here.
Refer: https://github.com/TexasInstruments/processor-sdk-doc/blob/master/CONTRIBUTING.md#indentation-and-whitespace

@StaticRocket StaticRocket left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Forgive me, I started skimming after a little bit. For more information about available language tags: https://pygments.org/docs/lexers/

I'm inclined to take this once these comments have been addressed. It's clear this is part of a larger refactor.

Comment thread source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-CBS.rst Outdated
1. Create and run the following script on AM625-SK:

::
.. code:: console

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
.. code:: console
.. code:: sh

1. Create and run the following script on J7VCL:

::
.. code:: console

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
.. code:: console
.. code:: sh

1. Create and run the following script on AM625-SK:

::
.. code:: console

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
.. code:: console
.. code:: sh

2. Create and run the following script on AM64-SK:

::
.. code:: console

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
.. code:: console
.. code:: sh

1. Run the following on AM625-SK:

::
.. code:: console

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
.. code:: console
.. code:: sh

2. Once eth0 and eth1 are up in AM625-SK, run the following on J7VCL:

::
.. code:: console

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
.. code:: console
.. code:: sh

Select ** as shown here:

::
.. code:: text

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
.. code:: text
.. code:: menuconfig

Select ** as shown here:

::
.. code:: text

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
.. code:: text
.. code:: menuconfig

Enable the following configs for Native Ethernet with CPSWng:

::
.. code:: console

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
.. code:: console
.. code:: text

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

Copy link
Copy Markdown
Author

Forgive me, I started skimming after a little bit. For more information about available language tags: https://pygments.org/docs/lexers/

I'm inclined to take this once these comments have been addressed. It's clear this is part of a larger refactor.

I have updated commit with your suggestions.

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