[dpdk-dev] [PATCH v2 20/37] doc: remove references to make in bbdev guides

Bruce Richardson bruce.richardson at intel.com
Fri Aug 21 11:41:06 CEST 2020


On Fri, Aug 21, 2020 at 02:22:14AM +0000, Chautru, Nicolas wrote:
> From: Power, Ciara <ciara.power at intel.com>
> > Make is no longer supported for compiling DPDK, references are now removed
> > in the documentation.
> > 
> > Reviewed-by: Kevin Laatz <kevin.laatz at intel.com>
> > Signed-off-by: Ciara Power <ciara.power at intel.com>
> > ---
> >  doc/guides/bbdevs/fpga_5gnr_fec.rst |  7 ++-----
> > doc/guides/bbdevs/fpga_lte_fec.rst  |  7 ++-----
> >  doc/guides/bbdevs/turbo_sw.rst      | 15 ---------------
> >  3 files changed, 4 insertions(+), 25 deletions(-)
> > 
> > diff --git a/doc/guides/bbdevs/fpga_5gnr_fec.rst
> > b/doc/guides/bbdevs/fpga_5gnr_fec.rst
> > index 6760391e8c..8e00c4ef22 100644
> > --- a/doc/guides/bbdevs/fpga_5gnr_fec.rst
> > +++ b/doc/guides/bbdevs/fpga_5gnr_fec.rst
> > @@ -51,10 +51,7 @@ FPGA 5GNR FEC does not support the following:
> >  Installation
> >  ------------
> > 
> > -Section 3 of the DPDK manual provides instructions on installing and compiling
> > DPDK. The -default set of bbdev compile flags may be found in
> > config/common_base, where for example -the flag to build the FPGA 5GNR FEC
> > device, ``CONFIG_RTE_LIBRTE_PMD_BBDEV_FPGA_5GNR_FEC``,
> > -is already set.
> > +Section 3 of the DPDK manual provides instructions on installing and compiling
> > DPDK.
> > 
> >  DPDK requires hugepages to be configured as detailed in section 2 of the DPDK
> > manual.
> >  The bbdev test application has been tested with a configuration 40 x 1GB
> > hugepages. The @@ -94,7 +91,7 @@ the UIO driver by repeating this
> > command for every function.
> >  .. code-block:: console
> > 
> >    cd <dpdk-top-level-directory>
> > -  insmod ./build/kmod/igb_uio.ko
> > +  insmod ./<build_dir>/kernel/linux/igb_uio/igb_uio.ko
> >    echo "8086 0d8f" > /sys/bus/pci/drivers/igb_uio/new_id
> >    lspci -vd8086:0d8f
> > 
> > diff --git a/doc/guides/bbdevs/fpga_lte_fec.rst
> > b/doc/guides/bbdevs/fpga_lte_fec.rst
> > index fdc8a76981..14ffa0ee14 100644
> > --- a/doc/guides/bbdevs/fpga_lte_fec.rst
> > +++ b/doc/guides/bbdevs/fpga_lte_fec.rst
> > @@ -50,10 +50,7 @@ FPGA LTE FEC does not support the following:
> >  Installation
> >  --------------
> > 
> > -Section 3 of the DPDK manual provides instructions on installing and compiling
> > DPDK. The -default set of bbdev compile flags may be found in
> > config/common_base, where for example -the flag to build the FPGA LTE FEC
> > device, ``CONFIG_RTE_LIBRTE_PMD_BBDEV_FPGA_LTE_FEC``, is already -set.
> > +Section 3 of the DPDK manual provides instructions on installing and compiling
> > DPDK.
> > 
> >  DPDK requires hugepages to be configured as detailed in section 2 of the DPDK
> > manual.
> >  The bbdev test application has been tested with a configuration 40 x 1GB
> > hugepages. The @@ -93,7 +90,7 @@ the UIO driver by repeating this
> > command for every function.
> >  .. code-block:: console
> > 
> >    cd <dpdk-top-level-directory>
> > -  insmod ./build/kmod/igb_uio.ko
> > +  insmod ./<build_dir>/kernel/linux/igb_uio/igb_uio.ko
> >    echo "1172 5052" > /sys/bus/pci/drivers/igb_uio/new_id
> >    lspci -vd1172:
> > 
> > diff --git a/doc/guides/bbdevs/turbo_sw.rst b/doc/guides/bbdevs/turbo_sw.rst
> > index 20620c2e20..3b93157890 100644
> > --- a/doc/guides/bbdevs/turbo_sw.rst
> > +++ b/doc/guides/bbdevs/turbo_sw.rst
> > @@ -12,14 +12,6 @@ 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
> > -By default these 2 flags are disabled by default. For AVX2 machine and SDK -
> > library installed then the first flag can be enabled. For AVX512 machine and -
> > SDK library installed then both flags can be enabled for full real time capability.
> 
> Hi, 
> We are losing information here. Even if the configuration options should not be documented based on an explicit reference make and config_base assumptions (agreed that they are no longer there), the steps should still capture the conf to be passed to meson so that the PMD can still be built with the avx2/avx512 intel libraries (ie. not the case by default due to additional dependency to retrieve the related libraries). 
> Thanks
> Nic

Hi Nic,

Can you perhaps suggest the appropriate wording to use? Given the size of
the patchset, I think we need individual maintainers to help provide the
appropriate doc adjustments.

Thanks,
/Bruce


More information about the dev mailing list