From patchwork Thu Mar 10 12:38:40 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 108649 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 1F2BDA0093; Thu, 10 Mar 2022 13:39:27 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BAF6241165; Thu, 10 Mar 2022 13:39:04 +0100 (CET) Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by mails.dpdk.org (Postfix) with ESMTP id 1630441157 for ; Thu, 10 Mar 2022 13:39:01 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1646915942; x=1678451942; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=a2ccahQ9+FJSNmnS1m6Zo/sT53vpKZ6vqcR2g432LfE=; b=SEoCOcg2v4SGyedwvvdIh/uWYNEt9UeR1v5oTtatUkQqHdC5idiUTEa9 JXMsXhxO7A9H9KH4Qfj30V2kxmSQOpUWyPt/NicQqseR11kbliUJtKxYm VHcvPh8Rc4CmtAPWGfN6ZX/2kCqhA+28xjAVLmeVuyj3n4vh3iH7wcZbR aH2tRqobhtLI+x/+vpFpxCU9jvdxiw+zWuplJxHbHSazMbjBkyFYPuOBL rFEnzbro5j/nPmNKrefXjjounrxQCKAb2PWw9x3crRE7WQLc54bigoAIB OJBPCg6+LzURorajFyRYCOK2zmO9X53FLRV83zNVSd3a0GRa/wXqCo6RX g==; X-IronPort-AV: E=McAfee;i="6200,9189,10281"; a="315957621" X-IronPort-AV: E=Sophos;i="5.90,170,1643702400"; d="scan'208";a="315957621" Received: from orsmga006.jf.intel.com ([10.7.209.51]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 10 Mar 2022 04:39:01 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.90,170,1643702400"; d="scan'208";a="513970227" Received: from silpixa00399126.ir.intel.com ([10.237.223.34]) by orsmga006.jf.intel.com with ESMTP; 10 Mar 2022 04:39:00 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: john.mcnamara@intel.com, Bruce Richardson Subject: [PATCH v2 5/8] doc/linux_gsg: expand list of directories Date: Thu, 10 Mar 2022 12:38:40 +0000 Message-Id: <20220310123843.612207-6-bruce.richardson@intel.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20220310123843.612207-1-bruce.richardson@intel.com> References: <20220308145001.529734-1-bruce.richardson@intel.com> <20220310123843.612207-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 -----------------------------------------