From patchwork Tue Mar 8 14:49:57 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 108601 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id E92A1A00C2; Tue, 8 Mar 2022 15:50:23 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id EC59F407FF; Tue, 8 Mar 2022 15:50:19 +0100 (CET) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by mails.dpdk.org (Postfix) with ESMTP id DB48A40141 for ; Tue, 8 Mar 2022 15:50:17 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1646751018; x=1678287018; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=aEbuN0u19DWtzFJhuqy67+DpGBFY94Bnzeza+Oa/zEs=; b=YSLfeoIUqlTMUR870JHMxGwedOYrhUS2iWqq6Lmlud08QAIKECGyIsCt qM2uFHNx+VREaj+LzTrJc/3rotsa1Df+JsaZujlXFFbQ3rS7gHg8Biu6E iFzZc8tj6GN3va3glGgFqX5q2PSzy4tSJ1a6Ia4wSKVEM3UOc9K3nOmlM +LEjuvhkPqCTmfVcJ9doX0X2w6y2IqzsBhcbrE4DjCAEgVX2+9QZY0/DN 47qYxgMIgyw/sKqeN4lD7S5grDCYQYIIok9VIepQyUAUaFQ8Idq6Tc9d6 MJ01/FQJkqG4bxpbSKWx0r/MSsn0G/Q29cTYd0J+kZPW/o+zuULb7z5bt Q==; X-IronPort-AV: E=McAfee;i="6200,9189,10279"; a="253527935" X-IronPort-AV: E=Sophos;i="5.90,165,1643702400"; d="scan'208";a="253527935" Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 08 Mar 2022 06:50:17 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.90,165,1643702400"; d="scan'208";a="510118217" Received: from silpixa00399126.ir.intel.com ([10.237.223.34]) by orsmga002.jf.intel.com with ESMTP; 08 Mar 2022 06:50:16 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: john.mcnamara@intel.com, Bruce Richardson Subject: [PATCH 1/5] doc/linux_gsg: add driver guides to document list Date: Tue, 8 Mar 2022 14:49:57 +0000 Message-Id: <20220308145001.529734-2-bruce.richardson@intel.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20220308145001.529734-1-bruce.richardson@intel.com> References: <20220308145001.529734-1-bruce.richardson@intel.com> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org The document roadmap section was missing any mention of the individual drivers guides which are important for users. Add them to list. Signed-off-by: Bruce Richardson --- doc/guides/linux_gsg/intro.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/doc/guides/linux_gsg/intro.rst b/doc/guides/linux_gsg/intro.rst index 890169e97f..ea98ac7425 100644 --- a/doc/guides/linux_gsg/intro.rst +++ b/doc/guides/linux_gsg/intro.rst @@ -34,3 +34,28 @@ The following is a list of DPDK documents in the suggested reading order: * Sample Applications User Guide: Describes a set of sample applications. Each chapter describes a sample application that showcases specific functionality and provides instructions on how to compile, run and use the sample application. + +* Driver Reference Guides: Provides details on each driver inside a particular category. + Separate guides exist for each of: + + * Baseband devices + + * Compression devices + + * Cryptographic accelerator devices + + * DMA devices + + * Event-based scheduling devices + + * General purpose GPU devices + + * Mempool drivers + + * Network (NIC) devices + + * "Raw" devices i.e. those not fitting into any other category + + * Regular expression devices + + * vDPA (vhost data path acceleration) devices \ No newline at end of file From patchwork Tue Mar 8 14:49:58 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 108602 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 1A0BDA00C2; Tue, 8 Mar 2022 15:50:31 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 15043410F3; Tue, 8 Mar 2022 15:50:21 +0100 (CET) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by mails.dpdk.org (Postfix) with ESMTP id DE14640141 for ; Tue, 8 Mar 2022 15:50:18 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1646751019; x=1678287019; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=SMuXqyZqFd2fM2Yy9dWw0+olCOoa+hD5O6J9juElKYk=; b=oAjT4p5kOX3j7FqNebc62V3uNup3cTZlA81ex2j5ViCI2TQIIVrhwzNr IuS8d3rUfMipUIC0guip4/HIZisoaWqiAYwSiqfMlCqBYI3SLlZ/K7sAF 9736WjANq1VCaE0/glsF4rMXtaP0gbxhw11d6L7KbTQP82DGsxv4g7y6J jlIeaKJMDm0cuFiV+k0LlVu6eCSLSOUasQXO6+r7VsLwFr2ivvte8AD77 heDoMkbeGD2Ag5XbnVvQPld1sGCnF+lMQq9dO7j6A601pPN7FVcbMcHuM iGjOizrzwbODljNkxJOSeX31BSiRIjmYH4piEsEtLV8Rvq7MhKZ1dCd87 w==; X-IronPort-AV: E=McAfee;i="6200,9189,10279"; a="253527937" X-IronPort-AV: E=Sophos;i="5.90,165,1643702400"; d="scan'208";a="253527937" Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 08 Mar 2022 06:50:18 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.90,165,1643702400"; d="scan'208";a="510118223" Received: from silpixa00399126.ir.intel.com ([10.237.223.34]) by orsmga002.jf.intel.com with ESMTP; 08 Mar 2022 06:50:17 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: john.mcnamara@intel.com, Bruce Richardson Subject: [PATCH 2/5] doc/linux_gsg: drop note about old chipset Date: Tue, 8 Mar 2022 14:49:58 +0000 Message-Id: <20220308145001.529734-3-bruce.richardson@intel.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20220308145001.529734-1-bruce.richardson@intel.com> References: <20220308145001.529734-1-bruce.richardson@intel.com> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org The chipsets referenced in the note[1] were all launched in 2012 and are now discontinued, so we can drop the note about them at this stage. [1] https://ark.intel.com/content/www/us/en/ark/products/codename/44946/products-formerly-cave-creek.html Signed-off-by: Bruce Richardson --- doc/guides/linux_gsg/sys_reqs.rst | 5 ----- 1 file changed, 5 deletions(-) diff --git a/doc/guides/linux_gsg/sys_reqs.rst b/doc/guides/linux_gsg/sys_reqs.rst index 9dccd54d9c..6f8799504a 100644 --- a/doc/guides/linux_gsg/sys_reqs.rst +++ b/doc/guides/linux_gsg/sys_reqs.rst @@ -8,11 +8,6 @@ System Requirements This chapter describes the packages required to compile the DPDK. -.. note:: - - If the DPDK is being used on an Intel\ |reg| Communications Chipset 89xx Series platform, - please consult the *Intel\ |reg| Communications Chipset 89xx Series Software for Linux Getting Started Guide*. - BIOS Setting Prerequisite on x86 -------------------------------- From patchwork Tue Mar 8 14:49:59 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 108603 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id B6812A00C2; Tue, 8 Mar 2022 15:50:36 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id E583A4113C; Tue, 8 Mar 2022 15:50:21 +0100 (CET) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by mails.dpdk.org (Postfix) with ESMTP id D0B194069F for ; Tue, 8 Mar 2022 15:50:19 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1646751020; x=1678287020; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=aDqJySP6cQ9C92UhgYi/3BGBTAtVJdfG9iKIdgf1PwU=; b=Lq0VicLGqXo54xBWy40d6V673aflGE0NpzDOZyMxXQkEgRmQBxWrgK71 C5p5uXbXAXJj9Zuzc00E/kZm3VaKfjxK7cuQ4GqMcWghL0rKgfVeinxUh /qgSKMm0brKZ0kforbrRCjh1vcpj5keipuK3ZclN8zqdwgC03QAx2O8n2 OAFDZy5bS0/+u9xTSPoB0jAMOPwjo4/ucVCbGifbuvLSCyV6D2JYH06Sj ti9B23PjTUCW6m/kIDfpRmXXEDslrEyd8jICWX3hoSgEOJKdyv/FLw4Bg RFzn+vVeoYxXJP6YRgNQeEGPJwUrmqytQOR+mlywbfHNbmeymfwHtTGFx A==; X-IronPort-AV: E=McAfee;i="6200,9189,10279"; a="253527939" X-IronPort-AV: E=Sophos;i="5.90,165,1643702400"; d="scan'208";a="253527939" Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 08 Mar 2022 06:50:19 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.90,165,1643702400"; d="scan'208";a="510118230" Received: from silpixa00399126.ir.intel.com ([10.237.223.34]) by orsmga002.jf.intel.com with ESMTP; 08 Mar 2022 06:50:18 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: john.mcnamara@intel.com, Bruce Richardson Subject: [PATCH 3/5] doc/linux_gsg: remove duplicated note Date: Tue, 8 Mar 2022 14:49:59 +0000 Message-Id: <20220308145001.529734-4-bruce.richardson@intel.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20220308145001.529734-1-bruce.richardson@intel.com> References: <20220308145001.529734-1-bruce.richardson@intel.com> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org A note about secure boot not allowing uio is present in both the system requirements section and the driver binding section. This fits better in the driver binding section, so the copy in system requirements can be removed. The document in general now also emphasises vfio over uio more than when this note was first added, reducing the need for this warning to be repeated. Signed-off-by: Bruce Richardson --- doc/guides/linux_gsg/sys_reqs.rst | 7 ------- 1 file changed, 7 deletions(-) diff --git a/doc/guides/linux_gsg/sys_reqs.rst b/doc/guides/linux_gsg/sys_reqs.rst index 6f8799504a..df367742cc 100644 --- a/doc/guides/linux_gsg/sys_reqs.rst +++ b/doc/guides/linux_gsg/sys_reqs.rst @@ -17,13 +17,6 @@ and high performance of small packets, BIOS setting changes may be needed. Consult the section on :ref:`Enabling Additional Functionality ` for more information on the required changes. -.. note:: - - If UEFI secure boot is enabled, the Linux kernel may disallow the use of - UIO on the system. Therefore, devices for use by DPDK should be bound to the - ``vfio-pci`` kernel module rather than ``igb_uio`` or ``uio_pci_generic``. - For more details see :ref:`linux_gsg_binding_kernel`. - Compilation of the DPDK ----------------------- From patchwork Tue Mar 8 14:50:00 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 108604 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id EC725A00C2; Tue, 8 Mar 2022 15:50:41 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BB745410F4; Tue, 8 Mar 2022 15:50:22 +0100 (CET) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by mails.dpdk.org (Postfix) with ESMTP id 111AC410E8 for ; Tue, 8 Mar 2022 15:50:20 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1646751021; x=1678287021; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=ZGhTWsEE3z1Vk9a5dVD79GpWqBzQgi5T6hSDUXuC21Q=; b=XbxAi+xsYz8DXubPsFCpvyJ9pNZYrX68CfaYCpY5z1kmYF3xj1huiquP /y45EV4RZ0VSB7M3rIH5PCo4dcS5Daf30L/o1TK0WcX4Qsy2bF/OuAVlg oL50eXolcuA9HnZtj1Kr7fUThCCPNQZk40HrtjmucL95SrPrCa76mapkq bMiOAwat/UepKaBD3wdQIQlOFN0/RLfMQ6AE4ua1AwKXwsiA9bAXfDun+ m9NG026VDBS1EXGZ5o7dNYfiy6vcU19mwQgvuikfoZUwz6TresWkXRtQk NauYImkAhui/dsYwY7wRdQhP3hcZxDyqNiJUnqrL2hLQ4ItZzWaJWuwRs Q==; X-IronPort-AV: E=McAfee;i="6200,9189,10279"; a="253527942" X-IronPort-AV: E=Sophos;i="5.90,165,1643702400"; d="scan'208";a="253527942" Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 08 Mar 2022 06:50:20 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.90,165,1643702400"; d="scan'208";a="510118235" Received: from silpixa00399126.ir.intel.com ([10.237.223.34]) by orsmga002.jf.intel.com with ESMTP; 08 Mar 2022 06:50:19 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: john.mcnamara@intel.com, Bruce Richardson Subject: [PATCH 4/5] doc/linux_gsg: merge requirements section for app building Date: Tue, 8 Mar 2022 14:50:00 +0000 Message-Id: <20220308145001.529734-5-bruce.richardson@intel.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20220308145001.529734-1-bruce.richardson@intel.com> References: <20220308145001.529734-1-bruce.richardson@intel.com> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org When building end-applications linked with DPDK, the only additional tool needed is pkg-config/pkgconf. However, the standard development tools meta-packages on most distro's include this as standard, meaning it does not really require its own section. The one outlier in the existing text is "alpine" where it is not present when using "libc-dev" target. However, changing "gcc" and "libc-dev" to "alpine-sdk" metapackage aligns alpine with the other distros in this regard. Signed-off-by: Bruce Richardson --- doc/guides/linux_gsg/sys_reqs.rst | 26 ++++++++++---------------- 1 file changed, 10 insertions(+), 16 deletions(-) diff --git a/doc/guides/linux_gsg/sys_reqs.rst b/doc/guides/linux_gsg/sys_reqs.rst index df367742cc..08d45898f0 100644 --- a/doc/guides/linux_gsg/sys_reqs.rst +++ b/doc/guides/linux_gsg/sys_reqs.rst @@ -27,11 +27,19 @@ Compilation of the DPDK The setup commands and installed packages needed on various systems may be different. For details on Linux distributions and the versions tested, please consult the DPDK Release Notes. -* General development tools including a supported C compiler such as gcc (version 4.9+) or clang (version 3.4+). +* General development tools including a supported C compiler such as gcc (version 4.9+) or clang (version 3.4+), + and ``pkg-config`` or ``pkgconf`` to be used when building end-user binaries against DPDK. * For RHEL/Fedora systems these can be installed using ``dnf groupinstall "Development Tools"`` * For Ubuntu/Debian systems these can be installed using ``apt install build-essential`` - * For Alpine Linux, ``apk add gcc libc-dev bsd-compat-headers libexecinfo-dev`` + * For Alpine Linux, ``apk add alpine-sdk bsd-compat-headers libexecinfo-dev`` + +.. note:: + + pkg-config 0.27, supplied with RHEL-7, + does not process the Libs.private section correctly, + resulting in statically linked applications not being linked properly. + Use an updated version of ``pkg-config`` or ``pkgconf`` instead when building applications * Python 3.5 or later. @@ -87,20 +95,6 @@ For poll-mode drivers, the additional dependencies for each driver can be found in that driver's documentation in the relevant DPDK guide document, e.g. :doc:`../nics/index` - -Building DPDK Applications --------------------------- - -The tool pkg-config or pkgconf, integrated in most build systems, -must be used to parse options and dependencies from libdpdk.pc. - -.. note:: - - pkg-config 0.27, supplied with RHEL-7, - does not process the Libs.private section correctly, - resulting in statically linked applications not being linked properly. - - Running DPDK Applications ------------------------- From patchwork Tue Mar 8 14:50:01 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 108605 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 39978A00C2; Tue, 8 Mar 2022 15:50:47 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 9653E41147; Tue, 8 Mar 2022 15:50:23 +0100 (CET) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by mails.dpdk.org (Postfix) with ESMTP id 3761241140 for ; Tue, 8 Mar 2022 15:50:22 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1646751022; x=1678287022; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=a2ccahQ9+FJSNmnS1m6Zo/sT53vpKZ6vqcR2g432LfE=; b=cERx+7vCN8O0UCDNghBkP1Ug2jZGtl4vE7OWIybBuUeNN3qpPkBwN1vj PPO8DbhwNNsPIQBv79G6ccxqHkk0SLNGclaBMeud41SodSenDV1xO9Ffq kYdPHL+ulqimDsEm18NMrU12EwLuqoPXbmberq8zVjpv171J4bl+RfELY ZNdZo/RRBEPAkvanuQsMaT+0/kFeYZuglTzLmCuMx6Wivlc2uVzNELd41 h63k0p3vdK6M1dSEjVwHs0DbypNS5+ic1RMrVQY+UJEnDRf6qEoZMLTKR Ju4HuEXOeL1DclN31KA8DC9s2NmIwJezVCl/BuUMwKLynPnIA371/GMtR A==; X-IronPort-AV: E=McAfee;i="6200,9189,10279"; a="253527946" X-IronPort-AV: E=Sophos;i="5.90,165,1643702400"; d="scan'208";a="253527946" Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 08 Mar 2022 06:50:21 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.90,165,1643702400"; d="scan'208";a="510118241" Received: from silpixa00399126.ir.intel.com ([10.237.223.34]) by orsmga002.jf.intel.com with ESMTP; 08 Mar 2022 06:50:20 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: john.mcnamara@intel.com, Bruce Richardson Subject: [PATCH 5/5] doc/linux_gsg: expand list of directories Date: Tue, 8 Mar 2022 14:50:01 +0000 Message-Id: <20220308145001.529734-6-bruce.richardson@intel.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20220308145001.529734-1-bruce.richardson@intel.com> References: <20220308145001.529734-1-bruce.richardson@intel.com> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Not all directories were given in the GSG document, but many of those omitted would be of interest to users, e.g. "doc", "license" and "usertools" directories. Adding these leaves only "devtools", and "kernel" as the only undocumented directories, so add them in too for completeness. When updating the section, add "including" to the line leading up to the directory list, indicating that, while the list is currently complete, it is not guaranteed to always be. Signed-off-by: Bruce Richardson --- doc/guides/linux_gsg/build_dpdk.rst | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/doc/guides/linux_gsg/build_dpdk.rst b/doc/guides/linux_gsg/build_dpdk.rst index 0b08492ca2..4f2def15ed 100644 --- a/doc/guides/linux_gsg/build_dpdk.rst +++ b/doc/guides/linux_gsg/build_dpdk.rst @@ -16,7 +16,11 @@ First, uncompress the archive and move to the uncompressed DPDK source directory tar xJf dpdk-.tar.xz cd dpdk- -The DPDK is composed of several directories: +The DPDK is composed of several directories, including: + +* doc: DPDK Documentation + +* license: DPDK license information * lib: Source code of DPDK libraries @@ -28,6 +32,13 @@ The DPDK is composed of several directories: * config, buildtools: Framework-related scripts and configuration +* usertools: Utility scripts for end-users of DPDK applications + +* devtools: Scripts for use by DPDK developers + +* kernel: Kernel modules needed for some operating systems + + Compiling and Installing DPDK System-wide -----------------------------------------