Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/109285/?format=api
{ "id": 109285, "url": "http://patches.dpdk.org/api/patches/109285/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20220406151106.2915304-19-juraj.linkes@pantheon.tech/", "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": "<20220406151106.2915304-19-juraj.linkes@pantheon.tech>", "list_archive_url": "https://inbox.dpdk.org/dev/20220406151106.2915304-19-juraj.linkes@pantheon.tech", "date": "2022-04-06T15:11:00", "name": "[RFC,v1,18/24] dts: merge DTS doc/dts_gsg/usr_guide/intro.rst to DPDK", "commit_ref": null, "pull_url": null, "state": "rfc", "archived": true, "hash": "855e3035d4134b37642b017c4c3a8fed00a0a373", "submitter": { "id": 1626, "url": "http://patches.dpdk.org/api/people/1626/?format=api", "name": "Juraj Linkeš", "email": "juraj.linkes@pantheon.tech" }, "delegate": { "id": 1, "url": "http://patches.dpdk.org/api/users/1/?format=api", "username": "tmonjalo", "first_name": "Thomas", "last_name": "Monjalon", "email": "thomas@monjalon.net" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20220406151106.2915304-19-juraj.linkes@pantheon.tech/mbox/", "series": [ { "id": 22379, "url": "http://patches.dpdk.org/api/series/22379/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=22379", "date": "2022-04-06T15:10:42", "name": "merge DTS documentation files to DPDK", "version": 1, "mbox": "http://patches.dpdk.org/series/22379/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/109285/comments/", "check": "warning", "checks": "http://patches.dpdk.org/api/patches/109285/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "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])\n\tby inbox.dpdk.org (Postfix) with ESMTP id DC786A0508;\n\tWed, 6 Apr 2022 17:13:41 +0200 (CEST)", "from [217.70.189.124] (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id BA1974290A;\n\tWed, 6 Apr 2022 17:11:38 +0200 (CEST)", "from lb.pantheon.sk (lb.pantheon.sk [46.229.239.20])\n by mails.dpdk.org (Postfix) with ESMTP id 7E77A428EC\n for <dev@dpdk.org>; Wed, 6 Apr 2022 17:11:32 +0200 (CEST)", "from localhost (localhost [127.0.0.1])\n by lb.pantheon.sk (Postfix) with ESMTP id CD76316BC0E;\n Wed, 6 Apr 2022 17:11:31 +0200 (CEST)", "from lb.pantheon.sk ([127.0.0.1])\n by localhost (lb.pantheon.sk [127.0.0.1]) (amavisd-new, port 10024)\n with ESMTP id 0xOJTjUQ7gg1; Wed, 6 Apr 2022 17:11:30 +0200 (CEST)", "from entguard.lab.pantheon.local (unknown [46.229.239.141])\n by lb.pantheon.sk (Postfix) with ESMTP id 98BF2185001;\n Wed, 6 Apr 2022 17:11:15 +0200 (CEST)" ], "X-Virus-Scanned": "amavisd-new at siecit.sk", "From": "=?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>", "To": "thomas@monjalon.net, david.marchand@redhat.com,\n Honnappa.Nagarahalli@arm.com, ohilyard@iol.unh.edu, lijuan.tu@intel.com", "Cc": "dev@dpdk.org, =?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>", "Subject": "[RFC PATCH v1 18/24] dts: merge DTS doc/dts_gsg/usr_guide/intro.rst\n to DPDK", "Date": "Wed, 6 Apr 2022 15:11:00 +0000", "Message-Id": "<20220406151106.2915304-19-juraj.linkes@pantheon.tech>", "X-Mailer": "git-send-email 2.25.1", "In-Reply-To": "<20220406151106.2915304-1-juraj.linkes@pantheon.tech>", "References": "<20220406151106.2915304-1-juraj.linkes@pantheon.tech>", "MIME-Version": "1.0", "Content-Type": "text/plain; charset=UTF-8", "Content-Transfer-Encoding": "8bit", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "---\n dts/doc/dts_gsg/usr_guide/intro.rst | 90 +++++++++++++++++++++++++++++\n 1 file changed, 90 insertions(+)\n create mode 100644 dts/doc/dts_gsg/usr_guide/intro.rst", "diff": "diff --git a/dts/doc/dts_gsg/usr_guide/intro.rst b/dts/doc/dts_gsg/usr_guide/intro.rst\nnew file mode 100644\nindex 0000000000..dc4c0bfa60\n--- /dev/null\n+++ b/dts/doc/dts_gsg/usr_guide/intro.rst\n@@ -0,0 +1,90 @@\n+Introduction\n+============\n+\n+This document describes how to install and configure the Data Plane Development Kit Test Suite (DTS) in a Linux environment.\n+DTS is an automation test tool for DPDK, wrote in `Python3`.\n+DTS includes one set of test cases and DPDK generic test framework.\n+DTS provides test example, references and framework for open source community.\n+Based on DTS, everyone can develop their test plan, automation script and configuration for own features and platform.\n+In addition, DTS provides a solution to allow that DPDK developers contribute their function test to certify their patch integration.\n+It only requires limited effort to maintain test cases once merged into DPDK Test Suite.\n+Everyone can utilize DTS to measure performance and functionality for features.\n+\n+As a generic test framework, DTS provides the following functions:\n+\n+* Communicate/manage DUT and Tester by SSH connection.\n+* Able to work with DUT (Device Under Test), which installed Fedora, Ubuntu, CentOS, RHEL, etc.\n+* Support virtualization hypervisor Qemu.\n+* Support both software and hardware traffic generators, including Scapy, TRex and IXIA®.\n+* Provide configure files to customize test suite and test cases to run under DUT.\n+* Provide debug and log functionalities for tracking test cases execution process.\n+* Support to output test result by excel, json, log text file, etc.\n+\n+DTS environment includes DUT (Device under Test), Tester and Traffic generator. DPDK are deployed on DUT and DTS can run on the Tester or DUT or the third machine.\n+\n+.. note::\n+\n+ * If run with functional testing, DTS uses `Scapy` as traffic generator, recommend installing DTS on Tester.\n+ * If run with performance testing, DTS can use `TRex` or IXIA as traffic gengerator based on your deployment and configuration, recommend installing DTS on DUT.\n+ * If use `TRex`, recommend deploying `TRex` and DUT on the same machine with different sockets.\n+\n+Please see a functional deployment example in the following figure:\n+\n+.. figure:: image/dts_func_deploy.png\n+\n+This architecture provides automatically mechanism to manage tester, DUT and packet generators, and remove dependency between test script and test environment/hardware.\n+It defines one abstraction layer for DPDK Test Suite, and provides extensibility to add more test script.\n+In the DPDK Test Suite Test Framework, it provides the following modules to help to manage device, platform, configure and test results.\n+\n+.. table::\n+\n+ +---------------------+------------------------------------------------------------------------------+\n+ | File Name/Directory | Description |\n+ +=====================+==============================================================================+\n+ | dts | Main Application for DTS |\n+ +---------------------+------------------------------------------------------------------------------+\n+ | framework | Folder with dts framework modules |\n+ +---------------------+------------------------------------------------------------------------------+\n+ | nics | Folder with different network device modules |\n+ +---------------------+------------------------------------------------------------------------------+\n+ | conf | Folder with different config files |\n+ +---------------------+------------------------------------------------------------------------------+\n+ | execution.cfg | Default execution file |\n+ +---------------------+------------------------------------------------------------------------------+\n+ | executions | Folder with several execution file samples |\n+ +---------------------+------------------------------------------------------------------------------+\n+ | output | Folder which contain running log files and result files |\n+ +---------------------+------------------------------------------------------------------------------+\n+ | dep | Folder with dependence scripts |\n+ +---------------------+------------------------------------------------------------------------------+\n+ | test_plans | Folder with rst files which contain the description of test suites and cases |\n+ +---------------------+------------------------------------------------------------------------------+\n+ | tests | Folder with test scripts for test suites and cases |\n+ +---------------------+------------------------------------------------------------------------------+\n+ | doc | Folder with DTS related documents |\n+ +---------------------+------------------------------------------------------------------------------+\n+ | requirements.txt | DTS required Python packages |\n+ +---------------------+------------------------------------------------------------------------------+\n+\n+These test script provides example and reference. Everyone can develop their test cases, verify their features functionality, and commit generic test report to maintainer.\n+, user-defined test cases, test plans and scripts must follow DPDK Test Suite standard including code standard, naming conventions, configure format, rst test plan, API.\n+\n+Please see test cases, which are included in the DPDK compliance test suites:\n+\n+.. table::\n+\n+ +---------------------+----------------------------------------------------------------------------------------------------------------------------+\n+ | Test Suite | Descriptions |\n+ +=====================+============================================================================================================================+\n+ | hello_world | Print a ``helloworld`` message on every enabled logic core. |\n+ +---------------------+----------------------------------------------------------------------------------------------------------------------------+\n+ | Timer | Shows how timer can be used in a RTE application. |\n+ +---------------------+----------------------------------------------------------------------------------------------------------------------------+\n+ | checksum_offload | Tests RX/TX L3/L4 Checksum offload features by Poll Mode Drivers |\n+ +---------------------+----------------------------------------------------------------------------------------------------------------------------+\n+ | jumbo_frame | Tests jumbo frames features by Poll Mode Drivers |\n+ +---------------------+----------------------------------------------------------------------------------------------------------------------------+\n+ | testpmd | Provides benchmark tests for the Intel Ethernet Controller (Niantic) Poll Mode Driver. |\n+ +---------------------+----------------------------------------------------------------------------------------------------------------------------+\n+ | L3fwd | Verifies Layer-3 Forwarding results using ``l3fwd`` application. |\n+ +---------------------+----------------------------------------------------------------------------------------------------------------------------+\n", "prefixes": [ "RFC", "v1", "18/24" ] }