[2/4] doc: remove build instructions where unneeded
Checks
Commit Message
The build should be described only in few places,
in order to maintain up-to-date, accurate and detailed instructions.
This change is removing some of the unneeded repetitions.
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
doc/guides/bbdevs/fpga_5gnr_fec.rst | 7 +--
doc/guides/bbdevs/fpga_lte_fec.rst | 7 +--
doc/guides/cryptodevs/virtio.rst | 9 +---
.../virtio_user_for_container_networking.rst | 6 ---
.../linux_gsg/nic_perf_intel_platform.rst | 8 +---
doc/guides/nics/bnxt.rst | 30 +++----------
doc/guides/nics/build_and_test.rst | 43 +++----------------
doc/guides/testpmd_app_ug/build_app.rst | 26 -----------
8 files changed, 15 insertions(+), 121 deletions(-)
Comments
On Wed, Jun 17, 2020 at 5:42 PM Thomas Monjalon <thomas@monjalon.net> wrote:
> The build should be described only in few places,
> in order to maintain up-to-date, accurate and detailed instructions.
> This change is removing some of the unneeded repetitions.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
>
For the Broadcom PMD part -
Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
> ---
> doc/guides/bbdevs/fpga_5gnr_fec.rst | 7 +--
> doc/guides/bbdevs/fpga_lte_fec.rst | 7 +--
> doc/guides/cryptodevs/virtio.rst | 9 +---
> .../virtio_user_for_container_networking.rst | 6 ---
> .../linux_gsg/nic_perf_intel_platform.rst | 8 +---
> doc/guides/nics/bnxt.rst | 30 +++----------
> doc/guides/nics/build_and_test.rst | 43 +++----------------
> doc/guides/testpmd_app_ug/build_app.rst | 26 -----------
> 8 files changed, 15 insertions(+), 121 deletions(-)
>
> diff --git a/doc/guides/bbdevs/fpga_5gnr_fec.rst
> b/doc/guides/bbdevs/fpga_5gnr_fec.rst
> index 19bba3661f..d5dcd3d765 100644
> --- a/doc/guides/bbdevs/fpga_5gnr_fec.rst
> +++ b/doc/guides/bbdevs/fpga_5gnr_fec.rst
> @@ -54,12 +54,7 @@ Installation
> Section 3 of the DPDK manual provides instuctions 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. It is assumed DPDK has been compiled using for instance:
> -
> -.. code-block:: console
> -
> - make install T=x86_64-native-linuxapp-gcc
> -
> +is already set.
>
> 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
> diff --git a/doc/guides/bbdevs/fpga_lte_fec.rst
> b/doc/guides/bbdevs/fpga_lte_fec.rst
> index 206b6f4f9b..191e89fcef 100644
> --- a/doc/guides/bbdevs/fpga_lte_fec.rst
> +++ b/doc/guides/bbdevs/fpga_lte_fec.rst
> @@ -53,12 +53,7 @@ Installation
> Section 3 of the DPDK manual provides instuctions 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. It is assumed DPDK has been compiled using for instance:
> -
> -.. code-block:: console
> -
> - make install T=x86_64-native-linuxapp-gcc
> -
> +set.
>
> 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
> diff --git a/doc/guides/cryptodevs/virtio.rst
> b/doc/guides/cryptodevs/virtio.rst
> index 1496ec9208..2c46bda866 100644
> --- a/doc/guides/cryptodevs/virtio.rst
> +++ b/doc/guides/cryptodevs/virtio.rst
> @@ -73,14 +73,7 @@ number of the virtio-crypto device:
> echo -n 0000:00:04.0 > /sys/bus/pci/drivers/virtio-pci/unbind
> echo "1af4 1054" > /sys/bus/pci/drivers/uio_pci_generic/new_id
>
> -Finally the front-end virtio crypto PMD driver can be installed:
> -
> -.. code-block:: console
> -
> - cd to the top-level DPDK directory
> - sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_VIRTIO_CRYPTO\)=n,\1=y,'
> config/common_base
> - make config T=x86_64-native-linux-gcc
> - make install T=x86_64-native-linux-gcc
> +Finally the front-end virtio crypto PMD driver can be installed.
>
> Tests
> -----
> diff --git a/doc/guides/howto/virtio_user_for_container_networking.rst
> b/doc/guides/howto/virtio_user_for_container_networking.rst
> index f31d918bcd..412b29664b 100644
> --- a/doc/guides/howto/virtio_user_for_container_networking.rst
> +++ b/doc/guides/howto/virtio_user_for_container_networking.rst
> @@ -56,12 +56,6 @@ Sample Usage
> Here we use Docker as container engine. It also applies to LXC, Rocket
> with
> some minor changes.
>
> -#. Compile DPDK.
> -
> - .. code-block:: console
> -
> - make install RTE_SDK=`pwd` T=x86_64-native-linux-gcc
> -
> #. Write a Dockerfile like below.
>
> .. code-block:: console
> diff --git a/doc/guides/linux_gsg/nic_perf_intel_platform.rst
> b/doc/guides/linux_gsg/nic_perf_intel_platform.rst
> index 1dabbce244..08be5d58b9 100644
> --- a/doc/guides/linux_gsg/nic_perf_intel_platform.rst
> +++ b/doc/guides/linux_gsg/nic_perf_intel_platform.rst
> @@ -124,17 +124,11 @@ The following are some recommendations on GRUB boot
> settings:
> Configurations before running DPDK
> ----------------------------------
>
> -1. Build the DPDK target and reserve huge pages.
> +1. Reserve huge pages.
> See the earlier section on :ref:`linux_gsg_hugepages` for more details.
>
> - The following shell commands may help with building and configuration:
> -
> .. code-block:: console
>
> - # Build DPDK target.
> - cd dpdk_folder
> - make install T=x86_64-native-linux-gcc -j
> -
> # Get the hugepage size.
> awk '/Hugepagesize/ {print $2}' /proc/meminfo
>
> diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst
> index ed650187e0..a53cdad21d 100644
> --- a/doc/guides/nics/bnxt.rst
> +++ b/doc/guides/nics/bnxt.rst
> @@ -56,33 +56,15 @@ The BNXT PMD supports operating with:
> * Linux igb_uio
> * BSD nic_uio
>
> -Compiling BNXT PMD
> -------------------
> -
> -To compile the BNXT PMD:
> -
> -.. code-block:: console
> -
> - make config T=x86_64-native-linux-gcc && make // for x86-64
> - make config T=x86_32-native-linux-gcc && make // for x86-32
> - make config T=armv8a-linux-gcc && make // for ARMv8
> -
> -Bind the device to one of the kernel modules listed above
> -
> -.. code-block:: console
> -
> - ./dpdk-devbind.py -b vfio-pci|igb_uio|uio_pci_generic
> bus_id:device_id.function_id
> -
> -Load an application (e.g. testpmd) with a default configuration (e.g. a
> single
> -TX /RX queue):
> -
> -.. code-block:: console
> -
> - ./testpmd -c 0xF -n 4 -- -i --portmask=0x1 --nb-cores=2
> -
> Running BNXT PMD
> ----------------
>
> +Bind the device to one of the kernel modules listed above
> +
> +.. code-block:: console
> +
> + ./dpdk-devbind.py -b vfio-pci|igb_uio|uio_pci_generic
> bus_id:device_id.function_id
> +
> The BNXT PMD can run on PF or VF.
>
> PCI-SIG Single Root I/O Virtualization (SR-IOV) involves the direct
> assignment
> diff --git a/doc/guides/nics/build_and_test.rst
> b/doc/guides/nics/build_and_test.rst
> index f99e019ff3..3138c0f880 100644
> --- a/doc/guides/nics/build_and_test.rst
> +++ b/doc/guides/nics/build_and_test.rst
> @@ -19,45 +19,12 @@ information on how to build and run testpmd.
> Driver Compilation
> ------------------
>
> -To compile a PMD for a platform, run make with appropriate target as
> shown below.
> -Use "make" command in Linux and "gmake" in FreeBSD. This will also build
> testpmd.
> +To compile a PMD for a platform, build DPDK
> +as described in the "Getting Started Guide" for your platform.
> +This will also build testpmd.
>
> -To check available targets:
> -
> -.. code-block:: console
> -
> - cd <DPDK-source-directory>
> - make showconfigs
> -
> -Example output:
> -
> -.. code-block:: console
> -
> - arm-armv7a-linux-gcc
> - arm64-armv8a-linux-gcc
> - arm64-dpaa-linux-gcc
> - arm64-thunderx-linux-gcc
> - arm64-xgene1-linux-gcc
> - i686-native-linux-gcc
> - i686-native-linux-icc
> - ppc_64-power8-linux-gcc
> - x86_64-native-freebsd-clang
> - x86_64-native-freebsd-gcc
> - x86_64-native-linux-clang
> - x86_64-native-linux-gcc
> - x86_64-native-linux-icc
> - x86_x32-native-linux-gcc
> -
> -To compile a PMD for Linux x86_64 gcc target, run the following "make"
> command:
> -
> -.. code-block:: console
> -
> - make install T=x86_64-native-linux-gcc
> -
> -Use ARM (ThunderX, DPAA, X-Gene) or PowerPC target for respective
> platform.
> -
> -For more information, refer to the :ref:`Getting Started Guide for Linux
> <linux_gsg>`
> -or :ref:`Getting Started Guide for FreeBSD <freebsd_gsg>` depending on
> your platform.
> +Detailed instructions are available
> +in the :doc:`meson build guide <../prog_guide/build-sdk-meson>`.
>
> Running testpmd in Linux
> ------------------------
> diff --git a/doc/guides/testpmd_app_ug/build_app.rst
> b/doc/guides/testpmd_app_ug/build_app.rst
> index d1ca9f3d19..4d08db75b5 100644
> --- a/doc/guides/testpmd_app_ug/build_app.rst
> +++ b/doc/guides/testpmd_app_ug/build_app.rst
> @@ -6,29 +6,3 @@ Compiling the Application
>
> The ``testpmd`` application is compiled as part of the main compilation
> of the DPDK libraries and tools.
> Refer to the DPDK Getting Started Guides for details.
> -The basic compilation steps are:
> -
> -#. Set the required environmental variables and go to the source
> directory:
> -
> - .. code-block:: console
> -
> - export RTE_SDK=/path/to/rte_sdk
> - cd $RTE_SDK
> -
> -#. Set the compilation target. For example:
> -
> - .. code-block:: console
> -
> - export RTE_TARGET=x86_64-native-linux-gcc
> -
> -#. Build the application:
> -
> - .. code-block:: console
> -
> - make install T=$RTE_TARGET
> -
> - The compiled application will be located at:
> -
> - .. code-block:: console
> -
> - $RTE_SDK/$RTE_TARGET/app/testpmd
> --
> 2.26.2
>
>
From: Thomas Monjalon
> The build should be described only in few places, in order to maintain up-to-
> date, accurate and detailed instructions.
> This change is removing some of the unneeded repetitions.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
> doc/guides/bbdevs/fpga_5gnr_fec.rst | 7 +--
> doc/guides/bbdevs/fpga_lte_fec.rst | 7 +--
Ok in principle to remove from these BBDEV drivers doc.
Should we include link to actual new build steps instead to help with transition? <../prog_guide/build-sdk-meson>
Also I see a typo in same paragraph "instuctions" instead of "instructions" in case you can fix in same commit.
> doc/guides/cryptodevs/virtio.rst | 9 +---
> .../virtio_user_for_container_networking.rst | 6 ---
> .../linux_gsg/nic_perf_intel_platform.rst | 8 +---
> doc/guides/nics/bnxt.rst | 30 +++----------
> doc/guides/nics/build_and_test.rst | 43 +++----------------
> doc/guides/testpmd_app_ug/build_app.rst | 26 -----------
> 8 files changed, 15 insertions(+), 121 deletions(-)
>
> diff --git a/doc/guides/bbdevs/fpga_5gnr_fec.rst
> b/doc/guides/bbdevs/fpga_5gnr_fec.rst
> index 19bba3661f..d5dcd3d765 100644
> --- a/doc/guides/bbdevs/fpga_5gnr_fec.rst
> +++ b/doc/guides/bbdevs/fpga_5gnr_fec.rst
> @@ -54,12 +54,7 @@ Installation
> Section 3 of the DPDK manual provides instuctions 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. It is assumed DPDK has been compiled using for instance:
> -
> -.. code-block:: console
> -
> - make install T=x86_64-native-linuxapp-gcc
> -
> +is already set.
>
> 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 diff --git a/doc/guides/bbdevs/fpga_lte_fec.rst
> b/doc/guides/bbdevs/fpga_lte_fec.rst
> index 206b6f4f9b..191e89fcef 100644
> --- a/doc/guides/bbdevs/fpga_lte_fec.rst
> +++ b/doc/guides/bbdevs/fpga_lte_fec.rst
> @@ -53,12 +53,7 @@ Installation
> Section 3 of the DPDK manual provides instuctions 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. It
> is assumed DPDK has been compiled using for instance:
> -
> -.. code-block:: console
> -
> - make install T=x86_64-native-linuxapp-gcc
> -
> +set.
>
> 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 diff --git a/doc/guides/cryptodevs/virtio.rst
> b/doc/guides/cryptodevs/virtio.rst
> index 1496ec9208..2c46bda866 100644
> --- a/doc/guides/cryptodevs/virtio.rst
> +++ b/doc/guides/cryptodevs/virtio.rst
> @@ -73,14 +73,7 @@ number of the virtio-crypto device:
> echo -n 0000:00:04.0 > /sys/bus/pci/drivers/virtio-pci/unbind
> echo "1af4 1054" > /sys/bus/pci/drivers/uio_pci_generic/new_id
>
> -Finally the front-end virtio crypto PMD driver can be installed:
> -
> -.. code-block:: console
> -
> - cd to the top-level DPDK directory
> - sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_VIRTIO_CRYPTO\)=n,\1=y,'
> config/common_base
> - make config T=x86_64-native-linux-gcc
> - make install T=x86_64-native-linux-gcc
> +Finally the front-end virtio crypto PMD driver can be installed.
>
> Tests
> -----
> diff --git a/doc/guides/howto/virtio_user_for_container_networking.rst
> b/doc/guides/howto/virtio_user_for_container_networking.rst
> index f31d918bcd..412b29664b 100644
> --- a/doc/guides/howto/virtio_user_for_container_networking.rst
> +++ b/doc/guides/howto/virtio_user_for_container_networking.rst
> @@ -56,12 +56,6 @@ Sample Usage
> Here we use Docker as container engine. It also applies to LXC, Rocket with
> some minor changes.
>
> -#. Compile DPDK.
> -
> - .. code-block:: console
> -
> - make install RTE_SDK=`pwd` T=x86_64-native-linux-gcc
> -
> #. Write a Dockerfile like below.
>
> .. code-block:: console
> diff --git a/doc/guides/linux_gsg/nic_perf_intel_platform.rst
> b/doc/guides/linux_gsg/nic_perf_intel_platform.rst
> index 1dabbce244..08be5d58b9 100644
> --- a/doc/guides/linux_gsg/nic_perf_intel_platform.rst
> +++ b/doc/guides/linux_gsg/nic_perf_intel_platform.rst
> @@ -124,17 +124,11 @@ The following are some recommendations on GRUB
> boot settings:
> Configurations before running DPDK
> ----------------------------------
>
> -1. Build the DPDK target and reserve huge pages.
> +1. Reserve huge pages.
> See the earlier section on :ref:`linux_gsg_hugepages` for more details.
>
> - The following shell commands may help with building and configuration:
> -
> .. code-block:: console
>
> - # Build DPDK target.
> - cd dpdk_folder
> - make install T=x86_64-native-linux-gcc -j
> -
> # Get the hugepage size.
> awk '/Hugepagesize/ {print $2}' /proc/meminfo
>
> diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst index
> ed650187e0..a53cdad21d 100644
> --- a/doc/guides/nics/bnxt.rst
> +++ b/doc/guides/nics/bnxt.rst
> @@ -56,33 +56,15 @@ The BNXT PMD supports operating with:
> * Linux igb_uio
> * BSD nic_uio
>
> -Compiling BNXT PMD
> -------------------
> -
> -To compile the BNXT PMD:
> -
> -.. code-block:: console
> -
> - make config T=x86_64-native-linux-gcc && make // for x86-64
> - make config T=x86_32-native-linux-gcc && make // for x86-32
> - make config T=armv8a-linux-gcc && make // for ARMv8
> -
> -Bind the device to one of the kernel modules listed above
> -
> -.. code-block:: console
> -
> - ./dpdk-devbind.py -b vfio-pci|igb_uio|uio_pci_generic
> bus_id:device_id.function_id
> -
> -Load an application (e.g. testpmd) with a default configuration (e.g. a single -
> TX /RX queue):
> -
> -.. code-block:: console
> -
> - ./testpmd -c 0xF -n 4 -- -i --portmask=0x1 --nb-cores=2
> -
> Running BNXT PMD
> ----------------
>
> +Bind the device to one of the kernel modules listed above
> +
> +.. code-block:: console
> +
> + ./dpdk-devbind.py -b vfio-pci|igb_uio|uio_pci_generic
> + bus_id:device_id.function_id
> +
> The BNXT PMD can run on PF or VF.
>
> PCI-SIG Single Root I/O Virtualization (SR-IOV) involves the direct assignment
> diff --git a/doc/guides/nics/build_and_test.rst
> b/doc/guides/nics/build_and_test.rst
> index f99e019ff3..3138c0f880 100644
> --- a/doc/guides/nics/build_and_test.rst
> +++ b/doc/guides/nics/build_and_test.rst
> @@ -19,45 +19,12 @@ information on how to build and run testpmd.
> Driver Compilation
> ------------------
>
> -To compile a PMD for a platform, run make with appropriate target as shown
> below.
> -Use "make" command in Linux and "gmake" in FreeBSD. This will also build
> testpmd.
> +To compile a PMD for a platform, build DPDK as described in the
> +"Getting Started Guide" for your platform.
> +This will also build testpmd.
>
> -To check available targets:
> -
> -.. code-block:: console
> -
> - cd <DPDK-source-directory>
> - make showconfigs
> -
> -Example output:
> -
> -.. code-block:: console
> -
> - arm-armv7a-linux-gcc
> - arm64-armv8a-linux-gcc
> - arm64-dpaa-linux-gcc
> - arm64-thunderx-linux-gcc
> - arm64-xgene1-linux-gcc
> - i686-native-linux-gcc
> - i686-native-linux-icc
> - ppc_64-power8-linux-gcc
> - x86_64-native-freebsd-clang
> - x86_64-native-freebsd-gcc
> - x86_64-native-linux-clang
> - x86_64-native-linux-gcc
> - x86_64-native-linux-icc
> - x86_x32-native-linux-gcc
> -
> -To compile a PMD for Linux x86_64 gcc target, run the following "make"
> command:
> -
> -.. code-block:: console
> -
> - make install T=x86_64-native-linux-gcc
> -
> -Use ARM (ThunderX, DPAA, X-Gene) or PowerPC target for respective
> platform.
> -
> -For more information, refer to the :ref:`Getting Started Guide for Linux
> <linux_gsg>` -or :ref:`Getting Started Guide for FreeBSD <freebsd_gsg>`
> depending on your platform.
> +Detailed instructions are available
> +in the :doc:`meson build guide <../prog_guide/build-sdk-meson>`.
>
> Running testpmd in Linux
> ------------------------
> diff --git a/doc/guides/testpmd_app_ug/build_app.rst
> b/doc/guides/testpmd_app_ug/build_app.rst
> index d1ca9f3d19..4d08db75b5 100644
> --- a/doc/guides/testpmd_app_ug/build_app.rst
> +++ b/doc/guides/testpmd_app_ug/build_app.rst
> @@ -6,29 +6,3 @@ Compiling the Application
>
> The ``testpmd`` application is compiled as part of the main compilation of
> the DPDK libraries and tools.
> Refer to the DPDK Getting Started Guides for details.
> -The basic compilation steps are:
> -
> -#. Set the required environmental variables and go to the source directory:
> -
> - .. code-block:: console
> -
> - export RTE_SDK=/path/to/rte_sdk
> - cd $RTE_SDK
> -
> -#. Set the compilation target. For example:
> -
> - .. code-block:: console
> -
> - export RTE_TARGET=x86_64-native-linux-gcc
> -
> -#. Build the application:
> -
> - .. code-block:: console
> -
> - make install T=$RTE_TARGET
> -
> - The compiled application will be located at:
> -
> - .. code-block:: console
> -
> - $RTE_SDK/$RTE_TARGET/app/testpmd
> --
> 2.26.2
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Thursday, June 18, 2020 8:42 AM
> To: dev@dpdk.org
> Cc: david.marchand@redhat.com; bruce.richardson@intel.com; Nicolas Chautru
> <nicolas.chautru@intel.com>; John McNamara <john.mcnamara@intel.com>;
> Marko Kovacevic <marko.kovacevic@intel.com>; Zhoujian (jay)
> <jianjay.zhou@huawei.com>; Ajit Khaparde <ajit.khaparde@broadcom.com>;
> Somnath Kotur <somnath.kotur@broadcom.com>; Wenzhuo Lu
> <wenzhuo.lu@intel.com>; Beilei Xing <beilei.xing@intel.com>; Bernard
> Iremonger <bernard.iremonger@intel.com>
> Subject: [PATCH 2/4] doc: remove build instructions where unneeded
>
> The build should be described only in few places, in order to maintain up-to-date,
> accurate and detailed instructions.
> This change is removing some of the unneeded repetitions.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
The virtio-crypto PMD is compiled as default now, so there's no need to enable
it manually. For the virtio-crypto PMD part:
Acked-by: Jay Zhou <jianjay.zhou@huawei.com>
> ---
> doc/guides/bbdevs/fpga_5gnr_fec.rst | 7 +--
> doc/guides/bbdevs/fpga_lte_fec.rst | 7 +--
> doc/guides/cryptodevs/virtio.rst | 9 +---
> .../virtio_user_for_container_networking.rst | 6 ---
> .../linux_gsg/nic_perf_intel_platform.rst | 8 +---
> doc/guides/nics/bnxt.rst | 30 +++----------
> doc/guides/nics/build_and_test.rst | 43 +++----------------
> doc/guides/testpmd_app_ug/build_app.rst | 26 -----------
> 8 files changed, 15 insertions(+), 121 deletions(-)
>
> diff --git a/doc/guides/bbdevs/fpga_5gnr_fec.rst
> b/doc/guides/bbdevs/fpga_5gnr_fec.rst
> index 19bba3661f..d5dcd3d765 100644
> --- a/doc/guides/bbdevs/fpga_5gnr_fec.rst
> +++ b/doc/guides/bbdevs/fpga_5gnr_fec.rst
> @@ -54,12 +54,7 @@ Installation
> Section 3 of the DPDK manual provides instuctions 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. It is assumed DPDK has been compiled using for instance:
> -
> -.. code-block:: console
> -
> - make install T=x86_64-native-linuxapp-gcc
> -
> +is already set.
>
> 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 diff --git a/doc/guides/bbdevs/fpga_lte_fec.rst
> b/doc/guides/bbdevs/fpga_lte_fec.rst
> index 206b6f4f9b..191e89fcef 100644
> --- a/doc/guides/bbdevs/fpga_lte_fec.rst
> +++ b/doc/guides/bbdevs/fpga_lte_fec.rst
> @@ -53,12 +53,7 @@ Installation
> Section 3 of the DPDK manual provides instuctions 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. It
> is assumed DPDK has been compiled using for instance:
> -
> -.. code-block:: console
> -
> - make install T=x86_64-native-linuxapp-gcc
> -
> +set.
>
> 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 diff --git a/doc/guides/cryptodevs/virtio.rst
> b/doc/guides/cryptodevs/virtio.rst
> index 1496ec9208..2c46bda866 100644
> --- a/doc/guides/cryptodevs/virtio.rst
> +++ b/doc/guides/cryptodevs/virtio.rst
> @@ -73,14 +73,7 @@ number of the virtio-crypto device:
> echo -n 0000:00:04.0 > /sys/bus/pci/drivers/virtio-pci/unbind
> echo "1af4 1054" > /sys/bus/pci/drivers/uio_pci_generic/new_id
>
> -Finally the front-end virtio crypto PMD driver can be installed:
> -
> -.. code-block:: console
> -
> - cd to the top-level DPDK directory
> - sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_VIRTIO_CRYPTO\)=n,\1=y,'
> config/common_base
> - make config T=x86_64-native-linux-gcc
> - make install T=x86_64-native-linux-gcc
> +Finally the front-end virtio crypto PMD driver can be installed.
>
> Tests
> -----
> diff --git a/doc/guides/howto/virtio_user_for_container_networking.rst
> b/doc/guides/howto/virtio_user_for_container_networking.rst
> index f31d918bcd..412b29664b 100644
> --- a/doc/guides/howto/virtio_user_for_container_networking.rst
> +++ b/doc/guides/howto/virtio_user_for_container_networking.rst
> @@ -56,12 +56,6 @@ Sample Usage
> Here we use Docker as container engine. It also applies to LXC, Rocket with
> some minor changes.
>
> -#. Compile DPDK.
> -
> - .. code-block:: console
> -
> - make install RTE_SDK=`pwd` T=x86_64-native-linux-gcc
> -
> #. Write a Dockerfile like below.
>
> .. code-block:: console
> diff --git a/doc/guides/linux_gsg/nic_perf_intel_platform.rst
> b/doc/guides/linux_gsg/nic_perf_intel_platform.rst
> index 1dabbce244..08be5d58b9 100644
> --- a/doc/guides/linux_gsg/nic_perf_intel_platform.rst
> +++ b/doc/guides/linux_gsg/nic_perf_intel_platform.rst
> @@ -124,17 +124,11 @@ The following are some recommendations on GRUB
> boot settings:
> Configurations before running DPDK
> ----------------------------------
>
> -1. Build the DPDK target and reserve huge pages.
> +1. Reserve huge pages.
> See the earlier section on :ref:`linux_gsg_hugepages` for more details.
>
> - The following shell commands may help with building and configuration:
> -
> .. code-block:: console
>
> - # Build DPDK target.
> - cd dpdk_folder
> - make install T=x86_64-native-linux-gcc -j
> -
> # Get the hugepage size.
> awk '/Hugepagesize/ {print $2}' /proc/meminfo
>
> diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst index
> ed650187e0..a53cdad21d 100644
> --- a/doc/guides/nics/bnxt.rst
> +++ b/doc/guides/nics/bnxt.rst
> @@ -56,33 +56,15 @@ The BNXT PMD supports operating with:
> * Linux igb_uio
> * BSD nic_uio
>
> -Compiling BNXT PMD
> -------------------
> -
> -To compile the BNXT PMD:
> -
> -.. code-block:: console
> -
> - make config T=x86_64-native-linux-gcc && make // for x86-64
> - make config T=x86_32-native-linux-gcc && make // for x86-32
> - make config T=armv8a-linux-gcc && make // for ARMv8
> -
> -Bind the device to one of the kernel modules listed above
> -
> -.. code-block:: console
> -
> - ./dpdk-devbind.py -b vfio-pci|igb_uio|uio_pci_generic
> bus_id:device_id.function_id
> -
> -Load an application (e.g. testpmd) with a default configuration (e.g. a single -TX
> /RX queue):
> -
> -.. code-block:: console
> -
> - ./testpmd -c 0xF -n 4 -- -i --portmask=0x1 --nb-cores=2
> -
> Running BNXT PMD
> ----------------
>
> +Bind the device to one of the kernel modules listed above
> +
> +.. code-block:: console
> +
> + ./dpdk-devbind.py -b vfio-pci|igb_uio|uio_pci_generic
> + bus_id:device_id.function_id
> +
> The BNXT PMD can run on PF or VF.
>
> PCI-SIG Single Root I/O Virtualization (SR-IOV) involves the direct assignment diff
> --git a/doc/guides/nics/build_and_test.rst b/doc/guides/nics/build_and_test.rst
> index f99e019ff3..3138c0f880 100644
> --- a/doc/guides/nics/build_and_test.rst
> +++ b/doc/guides/nics/build_and_test.rst
> @@ -19,45 +19,12 @@ information on how to build and run testpmd.
> Driver Compilation
> ------------------
>
> -To compile a PMD for a platform, run make with appropriate target as shown
> below.
> -Use "make" command in Linux and "gmake" in FreeBSD. This will also build
> testpmd.
> +To compile a PMD for a platform, build DPDK as described in the
> +"Getting Started Guide" for your platform.
> +This will also build testpmd.
>
> -To check available targets:
> -
> -.. code-block:: console
> -
> - cd <DPDK-source-directory>
> - make showconfigs
> -
> -Example output:
> -
> -.. code-block:: console
> -
> - arm-armv7a-linux-gcc
> - arm64-armv8a-linux-gcc
> - arm64-dpaa-linux-gcc
> - arm64-thunderx-linux-gcc
> - arm64-xgene1-linux-gcc
> - i686-native-linux-gcc
> - i686-native-linux-icc
> - ppc_64-power8-linux-gcc
> - x86_64-native-freebsd-clang
> - x86_64-native-freebsd-gcc
> - x86_64-native-linux-clang
> - x86_64-native-linux-gcc
> - x86_64-native-linux-icc
> - x86_x32-native-linux-gcc
> -
> -To compile a PMD for Linux x86_64 gcc target, run the following "make"
> command:
> -
> -.. code-block:: console
> -
> - make install T=x86_64-native-linux-gcc
> -
> -Use ARM (ThunderX, DPAA, X-Gene) or PowerPC target for respective platform.
> -
> -For more information, refer to the :ref:`Getting Started Guide for Linux
> <linux_gsg>` -or :ref:`Getting Started Guide for FreeBSD <freebsd_gsg>`
> depending on your platform.
> +Detailed instructions are available
> +in the :doc:`meson build guide <../prog_guide/build-sdk-meson>`.
>
> Running testpmd in Linux
> ------------------------
> diff --git a/doc/guides/testpmd_app_ug/build_app.rst
> b/doc/guides/testpmd_app_ug/build_app.rst
> index d1ca9f3d19..4d08db75b5 100644
> --- a/doc/guides/testpmd_app_ug/build_app.rst
> +++ b/doc/guides/testpmd_app_ug/build_app.rst
> @@ -6,29 +6,3 @@ Compiling the Application
>
> The ``testpmd`` application is compiled as part of the main compilation of the
> DPDK libraries and tools.
> Refer to the DPDK Getting Started Guides for details.
> -The basic compilation steps are:
> -
> -#. Set the required environmental variables and go to the source directory:
> -
> - .. code-block:: console
> -
> - export RTE_SDK=/path/to/rte_sdk
> - cd $RTE_SDK
> -
> -#. Set the compilation target. For example:
> -
> - .. code-block:: console
> -
> - export RTE_TARGET=x86_64-native-linux-gcc
> -
> -#. Build the application:
> -
> - .. code-block:: console
> -
> - make install T=$RTE_TARGET
> -
> - The compiled application will be located at:
> -
> - .. code-block:: console
> -
> - $RTE_SDK/$RTE_TARGET/app/testpmd
> --
> 2.26.2
18/06/2020 04:02, Chautru, Nicolas:
> From: Thomas Monjalon
> > The build should be described only in few places, in order to maintain up-to-
> > date, accurate and detailed instructions.
> > This change is removing some of the unneeded repetitions.
> >
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> > ---
> > doc/guides/bbdevs/fpga_5gnr_fec.rst | 7 +--
> > doc/guides/bbdevs/fpga_lte_fec.rst | 7 +--
>
> Ok in principle to remove from these BBDEV drivers doc.
> Should we include link to actual new build steps instead to help with transition? <../prog_guide/build-sdk-meson>
There are also some guides per platform.
I think it is not needed to add all the links
for general build inside a driver doc.
> Also I see a typo in same paragraph "instuctions" instead of "instructions" in case you can fix in same commit.
I will check
On Thu, Jun 18, 2020 at 02:42:16AM +0200, Thomas Monjalon wrote:
> The build should be described only in few places,
> in order to maintain up-to-date, accurate and detailed instructions.
> This change is removing some of the unneeded repetitions.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
Good cleanup.
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
@@ -54,12 +54,7 @@ Installation
Section 3 of the DPDK manual provides instuctions 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. It is assumed DPDK has been compiled using for instance:
-
-.. code-block:: console
-
- make install T=x86_64-native-linuxapp-gcc
-
+is already set.
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
@@ -53,12 +53,7 @@ Installation
Section 3 of the DPDK manual provides instuctions 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. It is assumed DPDK has been compiled using for instance:
-
-.. code-block:: console
-
- make install T=x86_64-native-linuxapp-gcc
-
+set.
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
@@ -73,14 +73,7 @@ number of the virtio-crypto device:
echo -n 0000:00:04.0 > /sys/bus/pci/drivers/virtio-pci/unbind
echo "1af4 1054" > /sys/bus/pci/drivers/uio_pci_generic/new_id
-Finally the front-end virtio crypto PMD driver can be installed:
-
-.. code-block:: console
-
- cd to the top-level DPDK directory
- sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_VIRTIO_CRYPTO\)=n,\1=y,' config/common_base
- make config T=x86_64-native-linux-gcc
- make install T=x86_64-native-linux-gcc
+Finally the front-end virtio crypto PMD driver can be installed.
Tests
-----
@@ -56,12 +56,6 @@ Sample Usage
Here we use Docker as container engine. It also applies to LXC, Rocket with
some minor changes.
-#. Compile DPDK.
-
- .. code-block:: console
-
- make install RTE_SDK=`pwd` T=x86_64-native-linux-gcc
-
#. Write a Dockerfile like below.
.. code-block:: console
@@ -124,17 +124,11 @@ The following are some recommendations on GRUB boot settings:
Configurations before running DPDK
----------------------------------
-1. Build the DPDK target and reserve huge pages.
+1. Reserve huge pages.
See the earlier section on :ref:`linux_gsg_hugepages` for more details.
- The following shell commands may help with building and configuration:
-
.. code-block:: console
- # Build DPDK target.
- cd dpdk_folder
- make install T=x86_64-native-linux-gcc -j
-
# Get the hugepage size.
awk '/Hugepagesize/ {print $2}' /proc/meminfo
@@ -56,33 +56,15 @@ The BNXT PMD supports operating with:
* Linux igb_uio
* BSD nic_uio
-Compiling BNXT PMD
-------------------
-
-To compile the BNXT PMD:
-
-.. code-block:: console
-
- make config T=x86_64-native-linux-gcc && make // for x86-64
- make config T=x86_32-native-linux-gcc && make // for x86-32
- make config T=armv8a-linux-gcc && make // for ARMv8
-
-Bind the device to one of the kernel modules listed above
-
-.. code-block:: console
-
- ./dpdk-devbind.py -b vfio-pci|igb_uio|uio_pci_generic bus_id:device_id.function_id
-
-Load an application (e.g. testpmd) with a default configuration (e.g. a single
-TX /RX queue):
-
-.. code-block:: console
-
- ./testpmd -c 0xF -n 4 -- -i --portmask=0x1 --nb-cores=2
-
Running BNXT PMD
----------------
+Bind the device to one of the kernel modules listed above
+
+.. code-block:: console
+
+ ./dpdk-devbind.py -b vfio-pci|igb_uio|uio_pci_generic bus_id:device_id.function_id
+
The BNXT PMD can run on PF or VF.
PCI-SIG Single Root I/O Virtualization (SR-IOV) involves the direct assignment
@@ -19,45 +19,12 @@ information on how to build and run testpmd.
Driver Compilation
------------------
-To compile a PMD for a platform, run make with appropriate target as shown below.
-Use "make" command in Linux and "gmake" in FreeBSD. This will also build testpmd.
+To compile a PMD for a platform, build DPDK
+as described in the "Getting Started Guide" for your platform.
+This will also build testpmd.
-To check available targets:
-
-.. code-block:: console
-
- cd <DPDK-source-directory>
- make showconfigs
-
-Example output:
-
-.. code-block:: console
-
- arm-armv7a-linux-gcc
- arm64-armv8a-linux-gcc
- arm64-dpaa-linux-gcc
- arm64-thunderx-linux-gcc
- arm64-xgene1-linux-gcc
- i686-native-linux-gcc
- i686-native-linux-icc
- ppc_64-power8-linux-gcc
- x86_64-native-freebsd-clang
- x86_64-native-freebsd-gcc
- x86_64-native-linux-clang
- x86_64-native-linux-gcc
- x86_64-native-linux-icc
- x86_x32-native-linux-gcc
-
-To compile a PMD for Linux x86_64 gcc target, run the following "make" command:
-
-.. code-block:: console
-
- make install T=x86_64-native-linux-gcc
-
-Use ARM (ThunderX, DPAA, X-Gene) or PowerPC target for respective platform.
-
-For more information, refer to the :ref:`Getting Started Guide for Linux <linux_gsg>`
-or :ref:`Getting Started Guide for FreeBSD <freebsd_gsg>` depending on your platform.
+Detailed instructions are available
+in the :doc:`meson build guide <../prog_guide/build-sdk-meson>`.
Running testpmd in Linux
------------------------
@@ -6,29 +6,3 @@ Compiling the Application
The ``testpmd`` application is compiled as part of the main compilation of the DPDK libraries and tools.
Refer to the DPDK Getting Started Guides for details.
-The basic compilation steps are:
-
-#. Set the required environmental variables and go to the source directory:
-
- .. code-block:: console
-
- export RTE_SDK=/path/to/rte_sdk
- cd $RTE_SDK
-
-#. Set the compilation target. For example:
-
- .. code-block:: console
-
- export RTE_TARGET=x86_64-native-linux-gcc
-
-#. Build the application:
-
- .. code-block:: console
-
- make install T=$RTE_TARGET
-
- The compiled application will be located at:
-
- .. code-block:: console
-
- $RTE_SDK/$RTE_TARGET/app/testpmd