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

[Jerin Jacob]

On Sat, Feb 26, 2022 at 2:52 PM Thomas Monjalon <thomas at 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 at 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


>
>