From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 4481CA04A5; Thu, 18 Jun 2020 04:17:03 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 0E02225B3; Thu, 18 Jun 2020 04:17:03 +0200 (CEST) Received: from huawei.com (szxga01-in.huawei.com [45.249.212.187]) by dpdk.org (Postfix) with ESMTP id D7C4C100C for ; Thu, 18 Jun 2020 04:17:01 +0200 (CEST) Received: from DGGEMM405-HUB.china.huawei.com (unknown [172.30.72.54]) by Forcepoint Email with ESMTP id 23B865BE85361E6A9DFE; Thu, 18 Jun 2020 10:17:00 +0800 (CST) Received: from DGGEMM423-HUB.china.huawei.com (10.1.198.40) by DGGEMM405-HUB.china.huawei.com (10.3.20.213) with Microsoft SMTP Server (TLS) id 14.3.487.0; Thu, 18 Jun 2020 10:16:39 +0800 Received: from DGGEMM528-MBX.china.huawei.com ([169.254.8.27]) by dggemm423-hub.china.huawei.com ([10.1.198.40]) with mapi id 14.03.0487.000; Thu, 18 Jun 2020 10:16:29 +0800 From: "Zhoujian (jay)" To: Thomas Monjalon , "dev@dpdk.org" CC: "david.marchand@redhat.com" , "bruce.richardson@intel.com" , Nicolas Chautru , John McNamara , "Marko Kovacevic" , Ajit Khaparde , Somnath Kotur , Wenzhuo Lu , Beilei Xing , Bernard Iremonger , "Huangweidong (C)" Thread-Topic: [PATCH 2/4] doc: remove build instructions where unneeded Thread-Index: AQHWRQllI/yjoRHJcE2NkqrsuJ2AfKjdoe3g Date: Thu, 18 Jun 2020 02:16:27 +0000 Message-ID: References: <20200618004218.3730743-1-thomas@monjalon.net> <20200618004218.3730743-3-thomas@monjalon.net> In-Reply-To: <20200618004218.3730743-3-thomas@monjalon.net> Accept-Language: zh-CN, en-US Content-Language: zh-CN X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [10.174.149.93] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-CFilter-Loop: Reflected Subject: Re: [dpdk-dev] [PATCH 2/4] doc: remove build instructions where unneeded X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" > -----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 Chautr= u > ; John McNamara ; > Marko Kovacevic ; Zhoujian (jay) > ; Ajit Khaparde ; > Somnath Kotur ; Wenzhuo Lu > ; Beilei Xing ; Bernard > Iremonger > Subject: [PATCH 2/4] doc: remove build instructions where unneeded >=20 > 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. >=20 > Signed-off-by: Thomas Monjalon The virtio-crypto PMD is compiled as default now, so there's no need to ena= ble it manually. For the virtio-crypto PMD part: Acked-by: Jay Zhou > --- > 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(-) >=20 > 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 comp= iling > 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 FE= C > 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=3Dx86_64-native-linuxapp-gcc > - > +is already set. >=20 > 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 comp= iling > 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=3Dx86_64-native-linuxapp-gcc > - > +set. >=20 > 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 >=20 > -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\)=3Dn,\1=3Dy,' > config/common_base > - make config T=3Dx86_64-native-linux-gcc > - make install T=3Dx86_64-native-linux-gcc > +Finally the front-end virtio crypto PMD driver can be installed. >=20 > 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 w= ith > some minor changes. >=20 > -#. Compile DPDK. > - > - .. code-block:: console > - > - make install RTE_SDK=3D`pwd` T=3Dx86_64-native-linux-gcc > - > #. Write a Dockerfile like below. >=20 > .. 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 > ---------------------------------- >=20 > -1. Build the DPDK target and reserve huge pages. > +1. Reserve huge pages. > See the earlier section on :ref:`linux_gsg_hugepages` for more detail= s. >=20 > - The following shell commands may help with building and configuration= : > - > .. code-block:: console >=20 > - # Build DPDK target. > - cd dpdk_folder > - make install T=3Dx86_64-native-linux-gcc -j > - > # Get the hugepage size. > awk '/Hugepagesize/ {print $2}' /proc/meminfo >=20 > 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 >=20 > -Compiling BNXT PMD > ------------------- > - > -To compile the BNXT PMD: > - > -.. code-block:: console > - > - make config T=3Dx86_64-native-linux-gcc && make // for x86-64 > - make config T=3Dx86_32-native-linux-gcc && make // for x86-32 > - make config T=3Darmv8a-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=3D0x1 --nb-cores=3D2 > - > Running BNXT PMD > ---------------- >=20 > +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. >=20 > PCI-SIG Single Root I/O Virtualization (SR-IOV) involves the direct assi= gnment diff > --git a/doc/guides/nics/build_and_test.rst b/doc/guides/nics/build_and_te= st.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 > ------------------ >=20 > -To compile a PMD for a platform, run make with appropriate target as sho= wn > 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. >=20 > -To check available targets: > - > -.. code-block:: console > - > - cd > - 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=3Dx86_64-native-linux-gcc > - > -Use ARM (ThunderX, DPAA, X-Gene) or PowerPC target for respective platfo= rm. > - > -For more information, refer to the :ref:`Getting Started Guide for Linux > ` -or :ref:`Getting Started Guide for FreeBSD ` > depending on your platform. > +Detailed instructions are available > +in the :doc:`meson build guide <../prog_guide/build-sdk-meson>`. >=20 > 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 >=20 > 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 direct= ory: > - > - .. code-block:: console > - > - export RTE_SDK=3D/path/to/rte_sdk > - cd $RTE_SDK > - > -#. Set the compilation target. For example: > - > - .. code-block:: console > - > - export RTE_TARGET=3Dx86_64-native-linux-gcc > - > -#. Build the application: > - > - .. code-block:: console > - > - make install T=3D$RTE_TARGET > - > - The compiled application will be located at: > - > - .. code-block:: console > - > - $RTE_SDK/$RTE_TARGET/app/testpmd > -- > 2.26.2