[dpdk-dev,1/2] doc: removed intel references from testpmd_ug

Message ID 1418835519-13596-2-git-send-email-siobhan.a.butler@intel.com (mailing list archive)
State Accepted, archived
Headers

Commit Message

Siobhan Butler Dec. 17, 2014, 4:58 p.m. UTC
  Removed redundant Intel references from TestPMD User Guide.

Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>
---
 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(-)
  

Comments

Iremonger, Bernard Dec. 17, 2014, 5:44 p.m. UTC | #1
> -----Original Message-----

> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Siobhan Butler

> Sent: Wednesday, December 17, 2014 4:59 PM

> To: dev@dpdk.org

> Subject: [dpdk-dev] [PATCH 1/2] doc: removed intel references from testpmd_ug

> 

> Removed redundant Intel references from TestPMD User Guide.

> 

> Signed-off-by: Siobhan Butler <siobhan.a.butler@intel.com>


Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>


 I have applied the patch to my tree next/dpdk-doc.
  

Patch

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