[dpdk-dev] [PATCH v4 3/3] doc: update mlx guides

[Mcnamara, John]

> -----Original Message-----
> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Shahaf Shuler
> Sent: Wednesday, July 26, 2017 6:03 PM
> To: thomas at monjalon.net
> Cc: dev at dpdk.org
> Subject: [dpdk-dev] [PATCH v4 3/3] doc: update mlx guides
> 
> Update the guides with:
>    * New supported features.
>    * Supported OFED and FW versions.
>    * Quick start guide.
>    * Performance tunning guide.
> 
> Signed-off-by: Shahaf Shuler <shahafs at mellanox.com>





> +6. Restart the driver:
> +
> +   .. code-block:: console
> +
> +        /etc/init.d/openibd restart
> +   or:
> +
> +   .. code-block:: console
> +
> +        service openibd restart


You are missing a blank line before the "or:" in the mlx4.rst and mlx5.rst files
which causes the following RST warnings:

$ make doc-guides-html
doc/guides/nics/mlx4.rst:341: 
    WARNING: Explicit markup ends without a blank line; unexpected unindent.
doc/guides/nics/mlx5.rst:416: 
    WARNING: Explicit markup ends without a blank line; unexpected unindent.



> +6. Verify IO non-posted prefetch is disabled by default. This can be
> checked
> +   via the BIOS configuration. Please contact you server provider for
> more
> +   information about the settings.
> +
> +.. hint::
> +
> +        On some machines, depends on the machine integrator, it is

Nice. I wasn't aware of the "hint" directive. Although "note::" is quite
similar.

John