diff mbox series

[v2,20/37] doc: remove references to make in bbdev guides

Message ID 20200820124140.13451-21-ciara.power@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers show
Series remove make support in DPDK | expand

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Power, Ciara Aug. 20, 2020, 12:41 p.m. UTC
Make is no longer supported for compiling DPDK, references are now
removed in the documentation.

Reviewed-by: Kevin Laatz <kevin.laatz@intel.com>
Signed-off-by: Ciara Power <ciara.power@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(-)

Comments

Chautru, Nicolas Aug. 21, 2020, 2:12 a.m. UTC | #1
> From: Power, Ciara <ciara.power@intel.com>
> Make is no longer supported for compiling DPDK, references are now removed
> in the documentation.
> 
> Reviewed-by: Kevin Laatz <kevin.laatz@intel.com>
> Signed-off-by: Ciara Power <ciara.power@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

Hi, 
Should this more specific? What do you mean by <build_dir> here? Is this defined somewhere else explicitly in doc? 
In other commit (with the python script) the assumption is that meson will install under <dpdk-top-level-directory>/build directory with hard coded path, ie. not forcing to other location. 
Can you clarify so that we are comprehensive and avoid confusion? 
Thanks
Nic
Chautru, Nicolas Aug. 21, 2020, 2:22 a.m. UTC | #2
From: Power, Ciara <ciara.power@intel.com>
> Make is no longer supported for compiling DPDK, references are now removed
> in the documentation.
> 
> Reviewed-by: Kevin Laatz <kevin.laatz@intel.com>
> Signed-off-by: Ciara Power <ciara.power@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
Bruce Richardson Aug. 21, 2020, 9:41 a.m. UTC | #3
On Fri, Aug 21, 2020 at 02:22:14AM +0000, Chautru, Nicolas wrote:
> From: Power, Ciara <ciara.power@intel.com>
> > Make is no longer supported for compiling DPDK, references are now removed
> > in the documentation.
> > 
> > Reviewed-by: Kevin Laatz <kevin.laatz@intel.com>
> > Signed-off-by: Ciara Power <ciara.power@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
Power, Ciara Aug. 21, 2020, 10:55 a.m. UTC | #4
Hi Nicolas,


>-----Original Message-----
>From: Chautru, Nicolas <nicolas.chautru@intel.com>
>Sent: Friday 21 August 2020 03:13
>To: Power, Ciara <ciara.power@intel.com>; dev@dpdk.org
>Cc: Mcnamara, John <john.mcnamara@intel.com>; Kovacevic, Marko
><marko.kovacevic@intel.com>
>Subject: RE: [PATCH v2 20/37] doc: remove references to make in bbdev
>guides
>
>> From: Power, Ciara <ciara.power@intel.com> Make is no longer supported
>> for compiling DPDK, references are now removed in the documentation.
>>
>> Reviewed-by: Kevin Laatz <kevin.laatz@intel.com>
>> Signed-off-by: Ciara Power <ciara.power@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(-)
>>
<snip>
>>    cd <dpdk-top-level-directory>
>> -  insmod ./build/kmod/igb_uio.ko
>> +  insmod ./<build_dir>/kernel/linux/igb_uio/igb_uio.ko
>
>Hi,
>Should this more specific? What do you mean by <build_dir> here? Is this
>defined somewhere else explicitly in doc?
>In other commit (with the python script) the assumption is that meson will
>install under <dpdk-top-level-directory>/build directory with hard coded path,
>ie. not forcing to other location.
>Can you clarify so that we are comprehensive and avoid confusion?
>Thanks
>Nic
>
>
>

The "<build_dir>" here represents the meson build folder, which is named by the user so can vary.
In the python script, I added "build" as the hardcoded path for the build folder, based on the example in the prog_guide/build-sdk-meson guide, which chooses to name the folder "build".

Thanks,
Ciara
Chautru, Nicolas Aug. 21, 2020, 3:18 p.m. UTC | #5
> From: Power, Ciara <ciara.power@intel.com>
> Hi Nicolas,
> 
> 
> >-----Original Message-----
> >From: Chautru, Nicolas <nicolas.chautru@intel.com>
> >Sent: Friday 21 August 2020 03:13
> >To: Power, Ciara <ciara.power@intel.com>; dev@dpdk.org
> >Cc: Mcnamara, John <john.mcnamara@intel.com>; Kovacevic, Marko
> ><marko.kovacevic@intel.com>
> >Subject: RE: [PATCH v2 20/37] doc: remove references to make in bbdev
> >guides
> >
> >> From: Power, Ciara <ciara.power@intel.com> Make is no longer
> >> supported for compiling DPDK, references are now removed in the
> documentation.
> >>
> >> Reviewed-by: Kevin Laatz <kevin.laatz@intel.com>
> >> Signed-off-by: Ciara Power <ciara.power@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(-)
> >>
> <snip>
> >>    cd <dpdk-top-level-directory>
> >> -  insmod ./build/kmod/igb_uio.ko
> >> +  insmod ./<build_dir>/kernel/linux/igb_uio/igb_uio.ko
> >
> >Hi,
> >Should this more specific? What do you mean by <build_dir> here? Is
> >this defined somewhere else explicitly in doc?
> >In other commit (with the python script) the assumption is that meson
> >will install under <dpdk-top-level-directory>/build directory with hard
> >coded path, ie. not forcing to other location.
> >Can you clarify so that we are comprehensive and avoid confusion?
> >Thanks
> >Nic
> >
> >
> >
> 
> The "<build_dir>" here represents the meson build folder, which is named by
> the user so can vary.
> In the python script, I added "build" as the hardcoded path for the build folder,
> based on the example in the prog_guide/build-sdk-meson guide, which chooses
> to name the folder "build".

Yes and I find this discrepancy as a source of confusion really. Either build location is flexible or not and in any case this needs to be deterministic and solid. 
I am not an expert on meson, unsure what is the best way to handle this but I certainly see room for errors we did not have with make. 
Any thought?

> 
> Thanks,
> Ciara
diff mbox series

Patch

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.
 
 This PMD supports the functions: FEC, Rate Matching and CRC functions detailed
 in the Features section.
@@ -151,13 +143,6 @@  Example:
     export FLEXRAN_SDK=<path-to-workspace>/FlexRAN-FEC-SDK-19-04/sdk/build-avx2-icc/install
     export DIR_WIRELESS_SDK=<path-to-workspace>/FlexRAN-FEC-SDK-19-04/sdk/build-avx2-icc/
 
-* Set ``CONFIG_RTE_BBDEV_SDK_AVX2=y`` and ``CONFIG_RTE_BBDEV_SDK_AVX512=y``
-  in DPDK common configuration file ``config/common_base`` to be able to use
-  the SDK libraries as mentioned above.
-  For AVX2 machine it is possible to only enable CONFIG_RTE_BBDEV_SDK_AVX2
-  for limited 4G functionality.
-  If no flag are set the PMD driver will still build but its capabilities
-  will be limited accordingly.
 
 To use the PMD in an application, user must: