From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM02-SN1-obe.outbound.protection.outlook.com (mail-sn1nam02on0087.outbound.protection.outlook.com [104.47.36.87]) by dpdk.org (Postfix) with ESMTP id 308992C2F for ; Mon, 3 Apr 2017 10:05:36 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=CAVIUMNETWORKS.onmicrosoft.com; s=selector1-cavium-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version; bh=5naaiRpdyNKfGiafR+ZPsnSQngNr56TSzatumq1EKsQ=; b=gpWX+CqaR9ygUhorMogzzyCcRwXbeAaz/ahF5NUV9qZo3mqY1pkv4p2HHyjpFIaPByHSwJK8yiQWuALtaexh4BLSaOGgcYFGdH0r+zTxJQEeB3Byla3BVeJP21/wBCCua2rl5QkchRyEvO6qexm8Azfpqp3Ch/I6GiB51Tg2noM= Authentication-Results: intel.com; dkim=none (message not signed) header.d=none;intel.com; dmarc=none action=none header.from=caviumnetworks.com; Received: from localhost.localdomain (14.140.2.178) by CY1PR07MB2280.namprd07.prod.outlook.com (10.164.112.158) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1005.10; Mon, 3 Apr 2017 08:05:32 +0000 Date: Mon, 3 Apr 2017 13:35:17 +0530 From: Shijith Thotton To: "Mcnamara, John" Cc: "dev@dpdk.org" , "Yigit, Ferruh" Message-ID: <20170403080504.GA20630@localhost.localdomain> References: <1491059040-20647-1-git-send-email-shijith.thotton@caviumnetworks.com> <1491059040-20647-2-git-send-email-shijith.thotton@caviumnetworks.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: User-Agent: Mutt/1.5.21 (2010-09-15) X-Originating-IP: [14.140.2.178] X-ClientProxiedBy: PN1PR01CA0027.INDPRD01.PROD.OUTLOOK.COM (10.164.137.34) To CY1PR07MB2280.namprd07.prod.outlook.com (10.164.112.158) X-MS-Office365-Filtering-Correlation-Id: b789c5f1-f9d8-4011-1a5b-08d47a683481 X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001)(201703131423075)(201703031133081); SRVR:CY1PR07MB2280; X-Microsoft-Exchange-Diagnostics: 1; CY1PR07MB2280; 3:bySKy6nRJMycF96ALpqpfQ+5ez551H8/cKmseqIA37E707szSPqXRBMn3uVm2AmrwNgyaAEovaHPW29G8onc4dXsWDYR5LaG3IVB92jukENflGXh1GRGor3LTAlc2onKB681zFGE5TIEAdXz4gsB6SDGzr64YXYzG9yeNVcZcVfj4/j1vGx4iaHn2xwLSlmZIFHVV6rEZYgxrdDU/1m3pIIoid0GBl86uciK8YKl4D9xSYfHoRwRyg2vcCwwgbhQ4GWCRStlsgACScw8RFs4JizyL4p6Pudnt6wtAN7LkCdRl9JkQ01T9RuFDAcv8C2E8KKXp6rVEVDs/w6QwySd8Q==; 25:JNM24XxYvB01lMpZfwgSTTv5FgdSUO4FUQYfvoqDhuIf6oYAYUnHPE9mfAoFrIwyF3HhbXWHFPXvmzfWZ/MMN7hfpnED4tMOdGLsv6DI8XYdQuushEWNUe4rKMtYKoQzenzxpx58Eto56WnBl+a0bUJlGR2+nXTZbwwpdV8Uq0tSsyupdaYhHu23DfQv6NxH7FWP6dK+/hTdBiPIS4jZwHT96yC8EQAsuwC6pXwf8Z2J3+CQ2FMDL4I5uVjAUOkdZVTHaUG4vzhor/RdQNGgpLOm5gyZJOPD28xBOEplUWZNerBH7jZ8w48Ab64E129yGnO3Lx9AuiNvNaR4uBYzcG+Gbp1vk2H+WNEBh+83/YGZBe7K7U1JadYPi+cbET17Fp1sAehDvsM3sh0tLF4J10JdB7t0+/oJSn6j1bGTBlOlvflq0MqvSo46hWCZpMTQnsvMIT0xxbrMlecdXTGfzA== X-Microsoft-Exchange-Diagnostics: 1; CY1PR07MB2280; 31:MGVacopEz2Oxsz/ynh4LYUFUBAFdQ8nUJ6nfIzxTmf/vC2tM7aHNZ6z7q6kx8kgGeaC1KiZgR5tKVClsGV2ZQeleMQoMhwnArjndP4OoS50YWCMp3cQRDCB97cE1NoboBRPufbgKG4gmTjgxCkE7kZdtUNqrpwBPm3S86TUTApQcLXgrZFKYk8peIVGhVeoZy24sA+YMleBlE9uHahrAc+ZTiIrKZq2QRYz3JMrUQBpAi/IULSjRaRPq/MfpqYpkayFSVMn/zQnos5FhrhIquCTt7zXSjC0su4OmwBgB87U=; 20:jz9c9Iu45EcpTrx6GVAS1GqjTl7WHlptsFP9ptraqnCCc0ANhfKYd82pJVxgw3PBv9+NO/gajww0z1OEBH85CZkHab8DPqr+hFXGYm+2Wy9cHJFxDtdlpKLGzq+GAE5OagpaEFQmsy8SroMYzK0A0aUC8wajOZ58EbzyCic3ZUJ3SvJV2NtbtLvCCI3QMlVL/7cRJl2FESNn2V+W+rHU1UkcDUAZso9wMQ4WQdtKjDyoZNy/947zUBrpihJu8Ak9f6i/WbA7CrBlI/3GjlA4w+2JPEsiuec80EWCuEbnG7tXYwsNgCDheGWsNYXRAOUnYZLgB3YuE6gKqueG0vWN9hVrvd97txMk1pnhRrp3sLB63ohW5tJtiF6Z1L8G8p19hCRUo05mdGZpvcke+Igb/FUW1c2RqTlW8yIoKdlTMJtf1rErRt8luzt0jCo0Zxy7VTA7qYyomYElTjtbRHSWDKmOnwptFqZEL+kQ7lkzcysxEn1TipBkp1SNHpo1xs/pLD/QrKDYJr+2hp4BR/yOldzRieiHF9Oxktoa7HkC75gDtop9wUW8CEYOZ2riU5IyrWp0qF7/6e5bRe9GoY+4fl4W/EnARw+XOvaMF8bBXXs= X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(278428928389397)(228905959029699); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6040450)(601004)(2401047)(8121501046)(5005006)(10201501046)(3002001)(93006095)(6041248)(20161123555025)(20161123562025)(20161123564025)(20161123560025)(201703131423075)(201702281528075)(201703061421075)(6072148); SRVR:CY1PR07MB2280; BCL:0; PCL:0; RULEID:; SRVR:CY1PR07MB2280; X-Microsoft-Exchange-Diagnostics: 1; CY1PR07MB2280; 4:qoSSiY8/ndTZ8rkvPTuPtG7sEN9bAqR8+DDVgXYydRnqmOsLltbCd8mX2VMIbePGCsl79hK/gmmgKK78AMQhRS4iDQl3XACuFj40078cPLR8bnkIp1UwLhnddxI+2leVj7x1ahvLDwWdVz5t01kVAGdXn4PQRTkWZI9wL713ULVf3ui1yiuXElFS/BTJBeZ42MdIUAr0QOlgVFXWGopM6amocncO8GzoF3mKjkqGiHvqJ9JL12uIoEMMt2VgzkM72zWM/0v0jgayoXKVw78Ncy5lUal7ihfx0GcGkqZcwxMXcczsTT/ES0EfLnPSBy3KlLJ/Y5K0IMdM8wD5QiVIXDOR+JBTDUYW2oUbRLJHdr/IAk/Zx/NUPlFOb8r2zDJXyxXr3JSCAF65jzl2SZ0Fn8idvPEpPIzdFkJsCT2Q2aeRXTS7s/eDhKxTu7P3moEewWpl2aRmg9yKru3JIDxL8U9znANykmUvFCpn4sADrBB/4Ijr7d1KiGrJXBKbbUXybl2TRcN5atc7k7yv5mCyNdjaMW2QT672fRP7s4o6l1GNHw2RiM6gSzCHfx9x2zc2eQXtE67La7T5+AfiXH3+4YoLgUxayxWAJ285YGO7X5u4cgyaBZGdt68rmokL6gsmlVS1+AYeWWQ5/ux51IIe8+vl2I6SFWXjNepDlkexjAAsGfRElhFd3JXsoq65mlP1skajVpOKQg7gJ/UYQXZNSGvgXAsxYQdeXFDtOnA8GA/11TQfxVOIhNdv62l4QaFEU8GDur8JQ+Iju66S1cMIDw== X-Forefront-PRVS: 0266491E90 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(4630300001)(6009001)(6069001)(39450400003)(39840400002)(39850400002)(39410400002)(39400400002)(13464003)(51444003)(377454003)(24454002)(110136004)(6506006)(33656002)(38730400002)(5660300001)(55016002)(54906002)(9686003)(2906002)(53936002)(25786009)(53546009)(6246003)(47776003)(66066001)(61506002)(4326008)(83506001)(305945005)(229853002)(50986999)(54356999)(76176999)(3846002)(42186005)(50466002)(23726003)(5009440100003)(1076002)(6116002)(4001350100001)(6666003)(7736002)(81166006)(6916009)(2950100002)(42882006)(189998001)(110426004)(129583001)(18370500001); DIR:OUT; SFP:1101; SCL:1; SRVR:CY1PR07MB2280; H:localhost.localdomain; FPR:; SPF:None; MLV:nov; PTR:InfoNoRecords; LANG:en; X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; CY1PR07MB2280; 23:mnV7921xYfgWBJt9dXjtRsmQucEQcDorYT2tQO85F?= =?us-ascii?Q?W3bZK/DHhKoklFMjkXaWEC2OWIXlBcfhOEP+GadtjKlsnD9ulPggp8JDdftB?= =?us-ascii?Q?n8l7Js3PNW6dQelK8hBooZGMREE+aAYh7KXBzl46xn41pV4q7B2Dhvlsb3et?= =?us-ascii?Q?gV7as56snolBopzgaPXAy12jI1pACFWbgYegMp1VZkE9bTRmSQDQmWkHEwvR?= =?us-ascii?Q?otacSFC2NundxYhWVLloV3pjOBeTpChWlEmMUOkC1IUS6QRkw1wcHPze2Q2Y?= =?us-ascii?Q?UeER5ykMUzeDv6q9ulgUFbNuw3cXIK1kwfO4PC+3xFzeXaDcQw480khvkg85?= =?us-ascii?Q?VSXhBy9dNPMYpY0mywXejCUtLIGx/31Z8vVGO4YETQJpiqw1TGdJoRsUI72m?= =?us-ascii?Q?OjaFjE5hVMPpGkIz5fQ8m2MUxiG9F1sKWkZJ11/jpwdNm4dlj+37mnFiFQb1?= =?us-ascii?Q?/vGcE8M2uIUDYr8Vw7FjqxbKizirTNzb9pV3XBzYivrN4UcKCWWq9KtrxkwQ?= =?us-ascii?Q?fadmdxsfLON3oeP3hHmsI6aqlsoyTuR3i6oARQ8WJ8laOgCDifmIkLIGX7mY?= =?us-ascii?Q?6IJF4fJM/D9wSzgDPJax3rJfWu7/WUlSJO7xJ7yjTOL8WUqmZxQ6GeYkRn8D?= =?us-ascii?Q?OsjsPQiGyiq6/35+RrvlU7cqJJ+3x5vSHPdhmWF/SRIyZR32jmG03JtDRz3k?= =?us-ascii?Q?/ssp1WDI/D7tIK+lekI+9ts4x5vREpKtf2lplAq+2a7bF/GgfDtJj2u2OUXO?= =?us-ascii?Q?7nyKjaNN141bGWzVOAG4ApbA3d6AcCFZDGo6dq2YlochNmiJo3A8JZYgnXjg?= =?us-ascii?Q?uOCy42bViUulrIVFtBHbEsa+cdW0P4sqU1ZVyHVOebdzbPKIiliNC0j6ERWb?= =?us-ascii?Q?aN7AvdyYB93YjB0e+Bous8nkxM8w8v8swP0HfcjS7bDoCViYrWxsGAL7534O?= =?us-ascii?Q?p7+yBbso4dR2yhUdY9KMGogOid3po1iCFzYJd/qEtPg4YKKl9ecrUGNF4I5X?= =?us-ascii?Q?vRtr5fraAcwkM2jH/JmBzPb110bdWriI3G5qg2uFlyB/64FhJVxDeUaxvD06?= =?us-ascii?Q?X5vrT5XvvBR8UV2pQDD3njwA+X5h18ncpX38MGi5TvKGn5XTfmRyI1SRoRZ6?= =?us-ascii?Q?E7h1EZddJtQOlihd1r9/cUJEU9rYc/BOy7COryxHIXQ52bfN+Mxn6M3Ef7Yf?= =?us-ascii?Q?lDX5TTkSu8SpLxP9+7RBgbkPQkbPb8IyWOdbOgkyD9qCB+6vDE6znyzIAOOw?= =?us-ascii?Q?WFW+9XJ5D0+DjZp4WVtunnJVwwE6BWEFKrtBcRpxvG1cLHYaBFijWCzdjgKr?= =?us-ascii?Q?e8ThHMW7KGmGbVhyPXQuUg=3D?= X-Microsoft-Exchange-Diagnostics: 1; CY1PR07MB2280; 6:scOQriEWNnT6xjWfi2JhWWM1vh/FfqjbuS9nRByymWRIx/TADS6piR1leyhPh7QRFtf2kcDo7M/cYl4+djVV4DDsVvSZx6WxFztnhmnzQ87qqRR+A/xtPobei2lrRadlQpEi9yW+jW5MjRoy0TJcNmvKa9+sfscv94ww0syWITlInDIMx8yJ+VJOiurDLC6NtzJQrplzefnH8Tc16tWFld22YTKvcB9CTgFTGkYDmjZV9waJLBeFHt9bclcTCHYcpRWcuCZBwMApinnqBNuJXEqDdYxyQjyMR/djZ1O4VChV1YX/vzbMyjUFvZ4TBqtKTsKJZXmZaWYGXoQx6K3cMs3XAoeNmjtJf+m6drRPuFB0PcZTLORh06+VVGo3ZtcQgNdGiBFhk1APJHfeHDNv6Q==; 5:vptX9RPt4QV/SIwOAoF4yqeVtj7su+xIA3bfuKg4SpzJpw4hpvyoAaqsvVllvsOvS0zhx5SVSYbXGjH0RqtaKizzXTtSLwc9nmqSxDMN+eutnWb82O2cT9d/Jo/KY9nAxHH7o54L+j7QZvaC9654EA==; 24:1FgPG/AqBqDJ4q0+sHKKdoj0qUXi/a45hZqWY3JwCV+KvUbBo6UOSFMhvZ+dMHUvR+MnmMU6afl5uxDqtP9sMIRvpO9f51tCi7NpkbIH7aI= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; CY1PR07MB2280; 7:WyyMXIcrA+s4xS8POUTAlc8PNKL3NcwU+xOlIZcbixfcBxk9FJb/hQllyIYJDFMigz6JWXfQIOM7/mwcigbyQoUjpP3QAdcRYGoP9MUT6EbW4v/h0k5p/QwhrNdMfOLYDTb3DkW2Eyii+rP3qOxux2ncL43gASfMNn3d3fyOSMRkNm8Q4c9uQiOlAxk55jz4H7aH2xmcQM/S8LcxtsgGo7Rg1ltiG1SxQUfB4peYjvMEP1gn6L80+YGYDdT4Pe2COsRuawkH89O3A7metYDblYr882UTbteT5cFnJo3SKi0SA4JccPqotSUh/4MSZ5uGBoYOHRkaa54znWWlTczMxA== X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 03 Apr 2017 08:05:32.6676 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY1PR07MB2280 Subject: Re: [dpdk-dev] [RFC 1/2] doc: add doc with steps to build PMD and run testpmd X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 03 Apr 2017 08:05:36 -0000 On Sun, Apr 02, 2017 at 12:11:05PM +0000, Mcnamara, John wrote: > > > > -----Original Message----- > > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Shijith Thotton > > Sent: Saturday, April 1, 2017 4:04 PM > > To: dev@dpdk.org > > Cc: Yigit, Ferruh > > Subject: [dpdk-dev] [RFC 1/2] doc: add doc with steps to build PMD and run > > testpmd > > > > Add a new document with steps to build PMDs and launch a sample test > > application, "testpmd". It can be included in other PMD documentations or > > be referred. > > Good idea. Nice addition. Some minor comments below. > > > > > Suggested-by: Ferruh Yigit > > Signed-off-by: Shijith Thotton > > --- > > doc/guides/nics/build_and_run.inc | 110 > > I think that this should be an rst doc that is included in the index > file for the nics dir. It should be included right after the overview > in the index. > OK. Will add a section as mentioned below. > > > +.. _pmd_build_and_run: > > If this doc is included in the index then it needs a better first section > title. Something like "Compiling and testing a PMD for a NIC". > > Then it should have a short introduction like: > > This section demonstrates how to compile and run a Poll Mode Driver > (PMD) for the available Network Interface Cards in DPDK using TestPMD. > > TestPMD is one of the reference applications distributed with the > DPDK. Its main purpose is to forward packets between Ethernet > ports on a network interface and as such is the best way to test > a PMD. > > It would be good to add a link to the TestPMD into docs but it doesn't have a > target. We should probably add one (it maybe be possible to link to the RST > file but that syntax isn't generally preferred). > > > Testpmd user guide can have a label "_testpmd_ug" and can be referenced here. > > + > > +Driver Compilation > > +------------------ > > This and the next sections should then become second level headings > > > + > > +To compile PMD for Linux x86_64 gcc target, run the following "make" > > command: > > > s/PMD/a PMD/ > > Also add at the end of this line or after the command: > > This command will also automatically build testpmd. > OK. > > + > > +.. code-block:: console > > + > > + cd > > + make install T=x86_64-native-linuxapp-gcc > > + > > +FreeBSD targets should use "gmake" command instead of "make". > > + > > +For more information, refer :ref:`Getting Started Guide for Linux > > +` or :ref:`Getting Started Guide for FreeBSD ` > > depending on your platform. > > s/refer/refer to the/ > > > > +Running testpmd in Linux > > +------------------------ > > + > > > +This section demonstrates how to launch ``testpmd`` in Linux. > > s/launch/setup and run/ > > > > +#. Start ``testpmd`` with basic parameters: > > + > > + .. code-block:: console > > + > > + ./x86_64-native-linuxapp-gcc/app/testpmd -c 0xf -n 4 -- -i > > We recently changed the docs to use "-l" instead of "-c". Can you make > that change here as well. > Will use "-l". > > Thanks, > > John Thanks, Shijith