From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by dpdk.org (Postfix) with ESMTP id F19309E3 for ; Sun, 2 Apr 2017 14:11:08 +0200 (CEST) Received: from orsmga004.jf.intel.com ([10.7.209.38]) by fmsmga105.fm.intel.com with ESMTP; 02 Apr 2017 05:11:07 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.36,263,1486454400"; d="scan'208";a="72784175" Received: from irsmsx154.ger.corp.intel.com ([163.33.192.96]) by orsmga004.jf.intel.com with ESMTP; 02 Apr 2017 05:11:07 -0700 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.241]) by IRSMSX154.ger.corp.intel.com ([169.254.12.233]) with mapi id 14.03.0319.002; Sun, 2 Apr 2017 13:11:06 +0100 From: "Mcnamara, John" To: Shijith Thotton , "dev@dpdk.org" CC: "Yigit, Ferruh" Thread-Topic: [dpdk-dev] [RFC 1/2] doc: add doc with steps to build PMD and run testpmd Thread-Index: AQHSqvme25EhdIZAiE+1d3xDPHh/6aGx9ZDA Date: Sun, 2 Apr 2017 12:11:05 +0000 Message-ID: References: <1491059040-20647-1-git-send-email-shijith.thotton@caviumnetworks.com> <1491059040-20647-2-git-send-email-shijith.thotton@caviumnetworks.com> In-Reply-To: <1491059040-20647-2-git-send-email-shijith.thotton@caviumnetworks.com> Accept-Language: en-GB, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_IC x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiMzllMmRiNzktNGViNi00M2QzLTliZTMtZDMzYjExNmM5MzM4IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE1LjkuNi42IiwiVHJ1c3RlZExhYmVsSGFzaCI6IjJ4R1dacThXakp5UjJudW44dWpZT1JcL2FCYjZaUjY3VzU4cnVLT1RsdUVVPSJ9 x-originating-ip: [163.33.239.181] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 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: Sun, 02 Apr 2017 12:11:09 -0000 > -----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 ru= n > testpmd >=20 > 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. >=20 > 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. > +.. _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=20 target. We should probably add one (it maybe be possible to link to the RST file but that syntax isn't generally preferred). > + > +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. > + > +.. code-block:: console > + > + cd > + make install T=3Dx86_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. Thanks, John