[dpdk-dev] [PATCH v2 2/3] docs/guides: updating turbo_sw building steps

[Ferruh Yigit]

On 6/5/2019 9:10 PM, Nicolas Chautru wrote:
> The documentation is clarified to point to steps on building the
> SDK libraries which are now publicly available.
> 

I can see new SDK link is in the documentation, but can you please put that
information into the commit log too, to highlight it?

> Signed-off-by: Nicolas Chautru <nicolas.chautru at intel.com>
> ---
>  doc/guides/bbdevs/turbo_sw.rst | 84 +++++++++++++++++++++++-------------------
>  1 file changed, 46 insertions(+), 38 deletions(-)
> 
> diff --git a/doc/guides/bbdevs/turbo_sw.rst b/doc/guides/bbdevs/turbo_sw.rst
> index 29f7ec9..196b3d6 100644
> --- a/doc/guides/bbdevs/turbo_sw.rst
> +++ b/doc/guides/bbdevs/turbo_sw.rst
> @@ -1,26 +1,43 @@
>  ..  SPDX-License-Identifier: BSD-3-Clause
>      Copyright(c) 2017 Intel Corporation
>  
> -SW Turbo Poll Mode Driver
> +SW FEC Poll Mode Driver

There seems two groups of changes in this patch,
- new SDK related changes,
- and renaming 's/Turbo/FEC'
For second one can you please put a brief description into commit log? Why Turbo
needs to be FEC. (This even can be a separate patch)

>  =========================
>  
> -The SW Turbo PMD (**baseband_turbo_sw**) provides a poll mode bbdev driver that utilizes
> -Intel optimized libraries for LTE Layer 1 workloads acceleration. This PMD
> -supports the functions: Turbo FEC, Rate Matching and CRC functions.
> +The SW FEC PMD (**baseband_turbo_sw**) provides a software only poll mode bbdev
> +driver that can optionally utilize Intel optimized libraries for LTE and 5GNR
> +Layer 1 workloads acceleration.

Is 5GNR Layer 1 workloads acceleration available in this stage of the PMD?

> +
> +Note that the driver can also be built without any dependency with reduced
> +functionality for maintenance purpose.
> +
> +To enable linking to the SDK libraries see detailed installation section below.
> +Two flags can be enabled depending on whether the target machine can support
> +AVX2 and AVX512 instructions sets and the related SDK libraries for vectorized
> +signal processing functions are installed :
> +- CONFIG_RTE_BBDEV_SDK_AVX2
> +- CONFIG_RTE_BBDEV_SDK_AVX512

This flag is not available (yet), can you please remove from this doc and add
with the patch that adds this flag?

<...>