diff mbox series

[v2,21/21] doc: add table for environment variables used by cnxk

Message ID 20220222193512.19292-21-ndabilpuram@marvell.com (mailing list archive)
State Accepted, archived
Delegated to: Jerin Jacob
Headers
Series [v2,01/21] common/cnxk: increase SMQ resource count |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/github-robot: build success github build: passed
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-abi-testing success Testing PASS

Commit Message

Nithin Dabilpuram Feb. 22, 2022, 7:35 p.m. UTC 
  Add table for environment variables used by cnxk drivers.

Signed-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
---
 doc/guides/platform/cnxk.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

Comments

Thomas Monjalon Feb. 26, 2022, 9:22 a.m. UTC | #1 
22/02/2022 20:35, Nithin Dabilpuram:
> Add table for environment variables used by cnxk drivers.
> 
> Signed-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
> ---
> +.. table:: cnxk environment variables
> +
> +   +---+-----------------------------+-----------------------------------------+
> +   | # | Variable name               | Usage                                   |
> +   +===+=============================+=========================================+
> +   | 1 | BPHY_INTR_MLOCK_DISABLE     | When defined disables memory locking in |
> +   |   |                             | BPHY environment.                       |
> +   +---+-----------------------------+-----------------------------------------+
> +   | 2 | ROC_CN10K_MBOX_TIMEOUT      | When set, overrides MBOX timeout by     |
> +   |   | ROC_MBOX_TIMEOUT            | value in milli seconds.                 |
> +   +---+-----------------------------+-----------------------------------------+
> +   | 3 | CN10K_ETH_SEC_IV_OVR        | When set, overrides outbound inline SA  |
> +   |   |                             | IV in CN10K. By default IV is generated |
> +   |   |                             | by HW. Format of variable is string     |
> +   |   |                             | of comma separated one byte values as   |
> +   |   |                             | for ex: "0x0, 0x10, 0x20, ..."          |
> +   +---+-----------------------------+-----------------------------------------+

Using tables for such list is a bad idea.
The source code is constrained in a small column,
and the HTML rendering is constrained by the page width.
I recommend switching to the definition list syntax
which has a nice rendering for such definitions.

Example:
``BPHY_INTR_MLOCK_DISABLE``
   Disable memory locking in BPHY environment.

See https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#lists-and-quote-like-blocks
Jerin Jacob Feb. 26, 2022, 9:37 a.m. UTC | #2 
On Sat, Feb 26, 2022 at 2:52 PM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> 22/02/2022 20:35, Nithin Dabilpuram:
> > Add table for environment variables used by cnxk drivers.
> >
> > Signed-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
> > ---
> > +.. table:: cnxk environment variables
> > +
> > +   +---+-----------------------------+-----------------------------------------+
> > +   | # | Variable name               | Usage                                   |
> > +   +===+=============================+=========================================+
> > +   | 1 | BPHY_INTR_MLOCK_DISABLE     | When defined disables memory locking in |
> > +   |   |                             | BPHY environment.                       |
> > +   +---+-----------------------------+-----------------------------------------+
> > +   | 2 | ROC_CN10K_MBOX_TIMEOUT      | When set, overrides MBOX timeout by     |
> > +   |   | ROC_MBOX_TIMEOUT            | value in milli seconds.                 |
> > +   +---+-----------------------------+-----------------------------------------+
> > +   | 3 | CN10K_ETH_SEC_IV_OVR        | When set, overrides outbound inline SA  |
> > +   |   |                             | IV in CN10K. By default IV is generated |
> > +   |   |                             | by HW. Format of variable is string     |
> > +   |   |                             | of comma separated one byte values as   |
> > +   |   |                             | for ex: "0x0, 0x10, 0x20, ..."          |
> > +   +---+-----------------------------+-----------------------------------------+
>
> Using tables for such list is a bad idea.
> The source code is constrained in a small column,
> and the HTML rendering is constrained by the page width.
> I recommend switching to the definition list syntax
> which has a nice rendering for such definitions.
>
> Example:
> ``BPHY_INTR_MLOCK_DISABLE``
>    Disable memory locking in BPHY environment.

Sure, You can remove this doc update while merging to the main tree.
We will submit a separate patch for updating this document
based on your suggestion.

>
> See https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#lists-and-quote-like-blocks


>
>
Thomas Monjalon Feb. 26, 2022, 1:31 p.m. UTC | #3 
26/02/2022 10:37, Jerin Jacob:
> On Sat, Feb 26, 2022 at 2:52 PM Thomas Monjalon <thomas@monjalon.net> wrote:
> >
> > 22/02/2022 20:35, Nithin Dabilpuram:
> > > Add table for environment variables used by cnxk drivers.
> > >
> > > Signed-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com>
> > > ---
> > > +.. table:: cnxk environment variables
> > > +
> > > +   +---+-----------------------------+-----------------------------------------+
> > > +   | # | Variable name               | Usage                                   |
> > > +   +===+=============================+=========================================+
> > > +   | 1 | BPHY_INTR_MLOCK_DISABLE     | When defined disables memory locking in |
> > > +   |   |                             | BPHY environment.                       |
> > > +   +---+-----------------------------+-----------------------------------------+
> > > +   | 2 | ROC_CN10K_MBOX_TIMEOUT      | When set, overrides MBOX timeout by     |
> > > +   |   | ROC_MBOX_TIMEOUT            | value in milli seconds.                 |
> > > +   +---+-----------------------------+-----------------------------------------+
> > > +   | 3 | CN10K_ETH_SEC_IV_OVR        | When set, overrides outbound inline SA  |
> > > +   |   |                             | IV in CN10K. By default IV is generated |
> > > +   |   |                             | by HW. Format of variable is string     |
> > > +   |   |                             | of comma separated one byte values as   |
> > > +   |   |                             | for ex: "0x0, 0x10, 0x20, ..."          |
> > > +   +---+-----------------------------+-----------------------------------------+
> >
> > Using tables for such list is a bad idea.
> > The source code is constrained in a small column,
> > and the HTML rendering is constrained by the page width.
> > I recommend switching to the definition list syntax
> > which has a nice rendering for such definitions.
> >
> > Example:
> > ``BPHY_INTR_MLOCK_DISABLE``
> >    Disable memory locking in BPHY environment.
> 
> Sure, You can remove this doc update while merging to the main tree.
> We will submit a separate patch for updating this document
> based on your suggestion.

It has been squashed in a commit adding the third variable,
so yes it can be dropped and submitted again for the 3 variables.
diff mbox series

Patch

diff --git a/doc/guides/platform/cnxk.rst b/doc/guides/platform/cnxk.rst
index 97e38c8..1cce2f9 100644
--- a/doc/guides/platform/cnxk.rst
+++ b/doc/guides/platform/cnxk.rst
@@ -606,3 +606,24 @@  CN10K:
    if Marvell toolchain is available then it can be used by overriding the
    c, cpp, ar, strip ``binaries`` attributes to respective Marvell
    toolchain binaries in ``config/arm/arm64_cn10k_linux_gcc`` file.
+
+Environment Variables
+~~~~~~~~~~~~~~~~~~~~~
+
+.. table:: cnxk environment variables
+
+   +---+-----------------------------+-----------------------------------------+
+   | # | Variable name               | Usage                                   |
+   +===+=============================+=========================================+
+   | 1 | BPHY_INTR_MLOCK_DISABLE     | When defined disables memory locking in |
+   |   |                             | BPHY environment.                       |
+   +---+-----------------------------+-----------------------------------------+
+   | 2 | ROC_CN10K_MBOX_TIMEOUT      | When set, overrides MBOX timeout by     |
+   |   | ROC_MBOX_TIMEOUT            | value in milli seconds.                 |
+   +---+-----------------------------+-----------------------------------------+
+   | 3 | CN10K_ETH_SEC_IV_OVR        | When set, overrides outbound inline SA  |
+   |   |                             | IV in CN10K. By default IV is generated |
+   |   |                             | by HW. Format of variable is string     |
+   |   |                             | of comma separated one byte values as   |
+   |   |                             | for ex: "0x0, 0x10, 0x20, ..."          |
+   +---+-----------------------------+-----------------------------------------+