X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Ftestpmd_app_ug%2Fintro.rst;h=5d8d8cf4eb190ee5e845f970e2a8f257f27647aa;hb=5630257fcc30397e7217139ec55da4f301f59fb7;hp=5fdde03eb0d4253207e4d9069de89d4ce6338a6d;hpb=aae5e11e847ec0b07b00c14564fdef787a0f3595;p=dpdk.git diff --git a/doc/guides/testpmd_app_ug/intro.rst b/doc/guides/testpmd_app_ug/intro.rst index 5fdde03eb0..5d8d8cf4eb 100644 --- a/doc/guides/testpmd_app_ug/intro.rst +++ b/doc/guides/testpmd_app_ug/intro.rst @@ -1,72 +1,14 @@ -.. BSD LICENSE - Copyright(c) 2010-2014 Intel Corporation. All rights reserved. - All rights reserved. - - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions - are met: - - * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in - the documentation and/or other materials provided with the - distribution. - * Neither the name of Intel Corporation nor the names of its - contributors may be used to endorse or promote products derived - from this software without specific prior written permission. - - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS - "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT - LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR - A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT - OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, - SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT - LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY - THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2010-2014 Intel Corporation. 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. - -DocumentationRoadmap --------------------- - -The following is a list of Intel® 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; - 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) - 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. - -* **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. - -.. note:: +It also serves as a example of how to build a more fully-featured application using the DPDK SDK. - These documents are available for download as a separate documentation package at the same location as the Intel® DPDK code package. +The guide shows how to build and run the testpmd application and +how to configure the application from the command line and the run-time environment.