Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/30513/?format=api
{ "id": 30513, "url": "http://patches.dpdk.org/api/patches/30513/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/1508318930-177267-2-git-send-email-marko.kovacevic@intel.com/", "project": { "id": 1, "url": "http://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<1508318930-177267-2-git-send-email-marko.kovacevic@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1508318930-177267-2-git-send-email-marko.kovacevic@intel.com", "date": "2017-10-18T09:28:50", "name": "[dpdk-dev,v8,2/2] doc: add new introduction to sample app guides", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "41f3614c2bb98bf5f9b499a7ad264370d36d6470", "submitter": { "id": 853, "url": "http://patches.dpdk.org/api/people/853/?format=api", "name": "Kovacevic, Marko", "email": "marko.kovacevic@intel.com" }, "delegate": null, "mbox": "http://patches.dpdk.org/project/dpdk/patch/1508318930-177267-2-git-send-email-marko.kovacevic@intel.com/mbox/", "series": [], "comments": "http://patches.dpdk.org/api/patches/30513/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/30513/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id 516B71B644;\n\tWed, 18 Oct 2017 11:29:06 +0200 (CEST)", "from mga01.intel.com (mga01.intel.com [192.55.52.88])\n\tby dpdk.org (Postfix) with ESMTP id 250B91B624\n\tfor <dev@dpdk.org>; Wed, 18 Oct 2017 11:29:04 +0200 (CEST)", "from orsmga003.jf.intel.com ([10.7.209.27])\n\tby fmsmga101.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;\n\t18 Oct 2017 02:28:56 -0700", "from silpixa00379011.ir.intel.com (HELO\n\tsilpixa00379011.ger.corp.intel.com) ([10.237.223.212])\n\tby orsmga003.jf.intel.com with ESMTP; 18 Oct 2017 02:28:55 -0700" ], "X-ExtLoop1": "1", "X-IronPort-AV": "E=Sophos; i=\"5.43,395,1503385200\"; d=\"scan'208\";\n\ta=\"1026392077\"", "From": "Marko Kovacevic <marko.kovacevic@intel.com>", "To": "john.mcnamara@intel.com", "Cc": "dev@dpdk.org,\n\tmarko.kovacevic@intel.com", "Date": "Wed, 18 Oct 2017 10:28:50 +0100", "Message-Id": "<1508318930-177267-2-git-send-email-marko.kovacevic@intel.com>", "X-Mailer": "git-send-email 2.5.5", "In-Reply-To": "<1508318930-177267-1-git-send-email-marko.kovacevic@intel.com>", "References": "<1508165454-165988-2-git-send-email-marko.kovacevic@intel.com>\n\t<1508318930-177267-1-git-send-email-marko.kovacevic@intel.com>", "Subject": "[dpdk-dev] [PATCH v8 2/2] doc: add new introduction to sample app\n\tguides", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<http://dpdk.org/ml/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://dpdk.org/ml/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<http://dpdk.org/ml/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "Add new Introduction Section into the sample app guides.\n\nSigned-off-by: Marko Kovacevic <marko.kovacevic@intel.com>\n---\n\nV8:\n Fixed Build issue (John)\n\n\n doc/guides/sample_app_ug/index.rst | 2 +\n doc/guides/sample_app_ug/intro.rst | 153 +++++++++++++++++++++++++++----------\n 2 files changed, 115 insertions(+), 40 deletions(-)", "diff": "diff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst\nindex 4f8340a..163b468 100644\n--- a/doc/guides/sample_app_ug/index.rst\n+++ b/doc/guides/sample_app_ug/index.rst\n@@ -1,4 +1,5 @@\n .. BSD LICENSE\n+\n Copyright(c) 2010-2015 Intel Corporation. All rights reserved.\n All rights reserved.\n \n@@ -28,6 +29,7 @@\n (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n \n+\n Sample Applications User Guides\n ===============================\n \ndiff --git a/doc/guides/sample_app_ug/intro.rst b/doc/guides/sample_app_ug/intro.rst\nindex d3f261b..ae12503 100644\n--- a/doc/guides/sample_app_ug/intro.rst\n+++ b/doc/guides/sample_app_ug/intro.rst\n@@ -1,5 +1,5 @@\n .. BSD LICENSE\n- Copyright(c) 2010-2014 Intel Corporation. All rights reserved.\n+ Copyright(c) 2010-2017 Intel Corporation. All rights reserved.\n All rights reserved.\n \n Redistribution and use in source and binary forms, with or without\n@@ -28,42 +28,115 @@\n (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n \n-Introduction\n-============\n-\n-This document describes the sample applications that are included in the Data Plane Development Kit (DPDK).\n-Each chapter describes a sample application that showcases specific functionality and\n-provides instructions on how to compile, run and use the sample application.\n-\n-Documentation Roadmap\n----------------------\n-\n-The following is a list of DPDK documents in suggested reading order:\n-\n-* **Release Notes** : Provides release-specific information, including supported features,\n- limitations, fixed issues, known issues and so on.\n- Also, provides the answers to frequently asked questions in FAQ format.\n-\n-* **Getting Started Guides** : Describes how to install and\n- configure the DPDK software for your operating system;\n- designed to get users up and running quickly with the software.\n-\n-* **Programmer's Guide:** Describes:\n-\n- * The software architecture and how to use it (through examples),\n- specifically in a Linux* application (linuxapp) environment.\n-\n- * The content of the DPDK, the build system\n- (including the commands that can be used in the root DPDK Makefile to build the development kit and an application)\n- \tand guidelines for porting an application.\n-\n- * Optimizations used in the software and those that should be considered for new development\n-\n-A glossary of terms is also provided.\n-\n-* **API Reference** : Provides detailed information about DPDK functions,\n- data structures and other programming constructs.\n-\n-* **Sample Applications User Guide** : Describes a set of sample applications.\n- Each chapter describes a sample application that showcases specific functionality and\n- provides instructions on how to compile, run and use the sample application.\n+Introduction to the DPDK Sample Applications\n+============================================\n+\n+The DPDK Sample Applications are small standalone applications which\n+demonstrate various features of DPDK. They can be considered as a cookbook of\n+DPDK features. Users interested in getting started with DPDK can take the\n+applications, try out the features, and then extend them to fit their needs.\n+\n+\n+The DPDK Sample Applications\n+----------------------------\n+\n+Table :numref:`table_sample_apps` shows a list of some of the main sample\n+applications that are available in the examples directory of DPDK:\n+\n+ .. _table_sample_apps:\n+\n+ .. table:: **Some of the DPDK Sample applications**\n+\n+ +---------------------------------------+--------------------------------------+\n+ | Bonding | Netmap Compatibility |\n+ +---------------------------------------+--------------------------------------+\n+ | Command Line | Packet Ordering |\n+ +---------------------------------------+--------------------------------------+\n+ | Distributor | Performance Thread |\n+ +---------------------------------------+--------------------------------------+\n+ | Ethtool | Precision Time Protocol (PTP) Client |\n+ +---------------------------------------+--------------------------------------+\n+ | Exception Path | Quality of Service (QoS) Metering |\n+ +---------------------------------------+--------------------------------------+\n+ | Hello World | QoS Scheduler |\n+ +---------------------------------------+--------------------------------------+\n+ | Internet Protocol (IP) Fragmentation | Quota and Watermark |\n+ +---------------------------------------+--------------------------------------+\n+ | IP Pipeline | RX/TX Callbacks |\n+ +---------------------------------------+--------------------------------------+\n+ | IP Reassembly | Server node EFD |\n+ +---------------------------------------+--------------------------------------+\n+ | IPsec Security Gateway | Basic Forwarding/Skeleton App |\n+ +---------------------------------------+--------------------------------------+\n+ | IPv4 multicast | Tunnel End Point (TEP) termination |\n+ +---------------------------------------+--------------------------------------+\n+ | Kernel NIC Interface | Timer |\n+ +---------------------------------------+--------------------------------------+\n+ | Network Layer 2 Forwarding + variants | Vhost |\n+ +---------------------------------------+--------------------------------------+\n+ | Network Layer 3 Forwarding + variants | Vhost Xen |\n+ +---------------------------------------+--------------------------------------+\n+ | Link Status Interrupt | VMDQ Forwarding |\n+ +---------------------------------------+--------------------------------------+\n+ | Load Balancer | VMDQ and DCB Forwarding |\n+ +---------------------------------------+--------------------------------------+\n+ | Multi-process | VM Power Management |\n+ +---------------------------------------+--------------------------------------+\n+\n+These examples range from simple to reasonably complex but most are designed\n+to demonstrate one particular feature of DPDK. Some of the more interesting\n+examples are highlighted below.\n+\n+\n+* :doc:`Hello World<hello_world>`: As with most introductions to a\n+ programming framework a good place to start is with the Hello World\n+ application. The Hello World example sets up the DPDK Environment Abstraction\n+ Layer (EAL), and prints a simple \"Hello World\" message to each of the DPDK\n+ enabled cores. This application doesn't do any packet forwarding but it is a\n+ good way to test if the DPDK environment is compiled and set up properly.\n+\n+* :doc:`Basic Forwarding/Skeleton Application<skeleton>`: The Basic\n+ Forwarding/Skeleton contains the minimum amount of code required to enable\n+ basic packet forwarding with DPDK. This allows you to test if your network\n+ interfaces are working with DPDK.\n+\n+* :doc:`Network Layer 2 forwarding<l2_forward_real_virtual>`: The Network Layer 2\n+ forwarding, or ``l2fwd`` application does forwarding based on Ethernet MAC\n+ addresses like a simple switch.\n+\n+* :doc:`Network Layer 3 forwarding<l3_forward>`: The Network Layer3\n+ forwarding, or ``l3fwd`` application does forwarding based on Internet\n+ Protocol, IPv4 or IPv6 like a simple router.\n+\n+* :doc:`Packet Distributor<dist_app>`: The Packet Distributor\n+ demonstrates how to distribute packets arriving on an Rx port to different\n+ cores for processing and transmission.\n+\n+* :doc:`Multi-Process Application<multi_process>`: The\n+ multi-process application shows how two DPDK processes can work together using\n+ queues and memory pools to share information.\n+\n+* :doc:`RX/TX callbacks Application<rxtx_callbacks>`: The RX/TX\n+ callbacks sample application is a packet forwarding application that\n+ demonstrates the use of user defined callbacks on received and transmitted\n+ packets. The application calculates the latency of a packet between RX\n+ (packet arrival) and TX (packet transmission) by adding callbacks to the RX\n+ and TX packet processing functions.\n+\n+* :doc:`IPSec Security Gateway<ipsec_secgw>`: The IPSec Security\n+ Gateway application is minimal example of something closer to a real world\n+ example. This is also a good example of an application using the DPDK\n+ Cryptodev framework.\n+\n+* :doc:`Precision Time Protocol (PTP) client<ptpclient>`: The PTP\n+ client is another minimal implementation of a real world application.\n+ In this case the application is a PTP client that communicates with a PTP\n+ master clock to synchronize time on a Network Interface Card (NIC) using the\n+ IEEE1588 protocol.\n+\n+* :doc:`Quality of Service (QoS) Scheduler<qos_scheduler>`: The QoS\n+ Scheduler application demonstrates the use of DPDK to provide QoS scheduling.\n+\n+There are many more examples shown in the following chapters. Each of the\n+documented sample applications show how to compile, configure and run the\n+application as well as explaining the main functionality of the code.\n", "prefixes": [ "dpdk-dev", "v8", "2/2" ] }