From: "Mcnamara, John" <john.mcnamara@intel.com>
To: Shijith Thotton <shijith.thotton@caviumnetworks.com>,
"dev@dpdk.org" <dev@dpdk.org>
Cc: "Yigit, Ferruh" <ferruh.yigit@intel.com>
Subject: Re: [dpdk-dev] [RFC 1/2] doc: add doc with steps to build PMD and run testpmd
Date: Sun, 2 Apr 2017 12:11:05 +0000 [thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE2332ADEB6@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <1491059040-20647-2-git-send-email-shijith.thotton@caviumnetworks.com>
> -----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 <ferruh.yigit@intel.com>
> 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 <ferruh.yigit@intel.com>
> Signed-off-by: Shijith Thotton <shijith.thotton@caviumnetworks.com>
> ---
> 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
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 <DPDK-source-directory>
> + 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
> +<linux_gsg>` or :ref:`Getting Started Guide for FreeBSD <freebsd_gsg>`
> 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
next prev parent reply other threads:[~2017-04-02 12:11 UTC|newest]
Thread overview: 42+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-04-01 15:03 [dpdk-dev] [RFC 0/2] doc: consolidate common part among PMD docs Shijith Thotton
2017-04-01 15:03 ` [dpdk-dev] [RFC 1/2] doc: add doc with steps to build PMD and run testpmd Shijith Thotton
2017-04-02 12:11 ` Mcnamara, John [this message]
2017-04-02 12:13 ` Mcnamara, John
2017-04-03 8:05 ` Shijith Thotton
2017-04-01 15:04 ` [dpdk-dev] [RFC 2/2] doc: include PMD build and run file in liquidio doc Shijith Thotton
2017-04-02 12:15 ` Mcnamara, John
2017-04-06 7:51 ` [dpdk-dev] [PATCH 0/8] doc: consolidate common part among PMD docs Shijith Thotton
2017-04-06 7:51 ` [dpdk-dev] [PATCH 1/8] doc: add doc to explain compiling and testing of PMD Shijith Thotton
2017-04-06 16:43 ` Mcnamara, John
2017-04-06 18:30 ` Thomas Monjalon
2017-04-07 7:07 ` Shijith Thotton
2017-04-07 9:23 ` Mcnamara, John
2017-04-07 9:34 ` Thomas Monjalon
2017-04-07 9:42 ` Jerin Jacob
2017-04-07 10:10 ` Shijith Thotton
2017-04-06 7:51 ` [dpdk-dev] [PATCH 2/8] doc: refer PMD compile and test section from liquidio doc Shijith Thotton
2017-04-06 16:43 ` Mcnamara, John
2017-04-06 7:51 ` [dpdk-dev] [PATCH 3/8] doc: refer PMD compile and test section from bnx2x doc Shijith Thotton
2017-04-06 16:45 ` Mcnamara, John
2017-04-06 7:51 ` [dpdk-dev] [PATCH 4/8] doc: refer PMD compile and test section from cxgbe doc Shijith Thotton
2017-04-06 16:45 ` Mcnamara, John
2017-04-06 7:51 ` [dpdk-dev] [PATCH 5/8] doc: refer PMD compile and test section from ena doc Shijith Thotton
2017-04-06 16:45 ` Mcnamara, John
2017-04-06 7:51 ` [dpdk-dev] [PATCH 6/8] doc: refer PMD compile and test section from i40e doc Shijith Thotton
2017-04-06 16:46 ` Mcnamara, John
2017-04-06 7:51 ` [dpdk-dev] [PATCH 7/8] doc: refer PMD compile and test section from nfp doc Shijith Thotton
2017-04-06 16:46 ` Mcnamara, John
2017-04-06 7:51 ` [dpdk-dev] [PATCH 8/8] doc: refer PMD compile and test section from qede doc Shijith Thotton
2017-04-06 16:46 ` Mcnamara, John
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 00/10] doc: consolidate common part among PMD docs Shijith Thotton
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 01/10] doc: add doc to explain compiling and testing of PMD Shijith Thotton
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 02/10] doc: refer PMD compile and test section from ark doc Shijith Thotton
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 03/10] doc: refer PMD compile and test section from bnx2x doc Shijith Thotton
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 04/10] doc: refer PMD compile and test section from cxgbe doc Shijith Thotton
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 05/10] doc: refer PMD compile and test section from ena doc Shijith Thotton
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 06/10] doc: refer PMD compile and test section from i40e doc Shijith Thotton
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 07/10] doc: refer PMD compile and test section from liquidio doc Shijith Thotton
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 08/10] doc: refer PMD compile and test section from nfp doc Shijith Thotton
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 09/10] doc: refer PMD compile and test section from qede doc Shijith Thotton
2017-04-11 18:56 ` [dpdk-dev] [PATCH v2 10/10] doc: refer PMD compile and test section from thunderx doc Shijith Thotton
2017-04-12 15:23 ` [dpdk-dev] [PATCH v2 00/10] doc: consolidate common part among PMD docs Ferruh Yigit
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=B27915DBBA3421428155699D51E4CFE2332ADEB6@IRSMSX103.ger.corp.intel.com \
--to=john.mcnamara@intel.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=shijith.thotton@caviumnetworks.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).