From patchwork Wed Dec 17 16:58:38 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Siobhan Butler X-Patchwork-Id: 2073 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id 09C2B808A; Wed, 17 Dec 2014 18:00:16 +0100 (CET) Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by dpdk.org (Postfix) with ESMTP id 51D0C8043 for ; Wed, 17 Dec 2014 17:58:45 +0100 (CET) Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orsmga103.jf.intel.com with ESMTP; 17 Dec 2014 08:56:25 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.04,691,1406617200"; d="scan'208";a="500291020" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by orsmga003.jf.intel.com with ESMTP; 17 Dec 2014 08:54:25 -0800 Received: from sivswdev02.ir.intel.com (sivswdev02.ir.intel.com [10.237.217.46]) by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id sBHGweID020477; Wed, 17 Dec 2014 16:58:40 GMT Received: from sivswdev02.ir.intel.com (localhost [127.0.0.1]) by sivswdev02.ir.intel.com with ESMTP id sBHGwelv013647; Wed, 17 Dec 2014 16:58:40 GMT Received: (from sabutler@localhost) by sivswdev02.ir.intel.com with id sBHGwe7O013643; Wed, 17 Dec 2014 16:58:40 GMT From: Siobhan Butler To: dev@dpdk.org Date: Wed, 17 Dec 2014 16:58:38 +0000 Message-Id: <1418835519-13596-2-git-send-email-siobhan.a.butler@intel.com> X-Mailer: git-send-email 1.7.4.1 In-Reply-To: <1418835519-13596-1-git-send-email-siobhan.a.butler@intel.com> References: <1418835519-13596-1-git-send-email-siobhan.a.butler@intel.com> MIME-Version: 1.0 Subject: [dpdk-dev] =?utf-8?q?=5BPATCH_1/2=5D_doc=3A_removed_intel_referen?= =?utf-8?q?ces_from_testpmd=5Fug?= X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Removed redundant Intel references from TestPMD User Guide. Signed-off-by: Siobhan Butler Acked-by: Bernard Iremonger --- doc/guides/testpmd_app_ug/build_app.rst | 4 ++-- doc/guides/testpmd_app_ug/intro.rst | 18 +++++++++--------- doc/guides/testpmd_app_ug/run_app.rst | 4 ++-- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/doc/guides/testpmd_app_ug/build_app.rst b/doc/guides/testpmd_app_ug/build_app.rst index bdaec8a..8b0a857 100644 --- a/doc/guides/testpmd_app_ug/build_app.rst +++ b/doc/guides/testpmd_app_ug/build_app.rst @@ -31,8 +31,8 @@ Compiling the Application ========================= -The testpmd application is compiled as part of the main compilation of the Intel® DPDK libraries and tools. -Refer to the Intel® DPDK Getting Started Guide for details. +The testpmd application is compiled as part of the main compilation of the DPDK libraries and tools. +Refer to the DPDK Getting Started Guide for details. The basic compilation steps are: #. Set the required environmental variables and go to the source directory: diff --git a/doc/guides/testpmd_app_ug/intro.rst b/doc/guides/testpmd_app_ug/intro.rst index 5fdde03..d9d17dc 100644 --- a/doc/guides/testpmd_app_ug/intro.rst +++ b/doc/guides/testpmd_app_ug/intro.rst @@ -31,37 +31,37 @@ Introduction ============ -This document is a user guide for the testpmd example application that is shipped as part of the Intel® Data Plane Development Kit. +This document is a user guide for the testpmd example application that is shipped as part of the Data Plane Development Kit. -The testpmd application can be used to test the Intel® DPDK in a packet forwarding mode +The testpmd application can be used to test the DPDK in a packet forwarding mode and also to access NIC hardware features such as Flow Director. -It also serves as a example of how to build a more fully-featured application using the Intel® DPDK SDK. +It also serves as a example of how to build a more fully-featured application using the DPDK SDK. DocumentationRoadmap -------------------- -The following is a list of Intel® DPDK documents in the suggested reading order: +The following is a list of DPDK documents in the suggested reading order: * **Release Notes** : Provides release-specific information, including supported features, limitations, fixed issues, known issues and so on. Also, provides the answers to frequently asked questions in FAQ format. -* **Getting Started Guide** (this document): Describes how to install and configure the Intel® DPDK; +* **Getting Started Guide** (this document): Describes how to install and configure the DPDK; designed to get users up and running quickly with the software. * **Programmer's Guide** : Describes: * The software architecture and how to use it (through examples), specifically in a Linux* application (linuxapp) environment - * The content of the Intel® DPDK, the build system - (including the commands that can be used in the root Intel® DPDK Makefile to build the development kit and an application) + * The content of the DPDK, the build system + (including the commands that can be used in the root DPDK Makefile to build the development kit and an application) and guidelines for porting an application * Optimizations used in the software and those that should be considered for new development A glossary of terms is also provided. -* **API Reference** : Provides detailed information about Intel® DPDK functions, data structures and other programming constructs. +* **API Reference** : Provides detailed information about DPDK functions, data structures and other programming constructs. * **Sample Applications User Guide** : Describes a set of sample applications. Each chapter describes a sample application that showcases specific functionality and @@ -69,4 +69,4 @@ The following is a list of Intel® DPDK documents in the suggested reading order .. note:: - These documents are available for download as a separate documentation package at the same location as the Intel® DPDK code package. + These documents are available for download as a separate documentation package at the same location as the DPDK code package. diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst index ac2d07e..67f62d2 100644 --- a/doc/guides/testpmd_app_ug/run_app.rst +++ b/doc/guides/testpmd_app_ug/run_app.rst @@ -35,8 +35,8 @@ EAL Command-line Options ------------------------ The following are the EAL command-line options that can be used in conjunction with the testpmd, -or any other Intel® DPDK application. -See the Intel® DPDK Getting Started Guide for more information on these options. +or any other DPDK application. +See the DPDK Getting Started Guide for more information on these options. * -c COREMASK