From: "Mcnamara, John" <john.mcnamara@intel.com>
To: Matej Vido <matejvido@gmail.com>, "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH v2 4/5] doc: add documentation for szedata2 PMD
Date: Fri, 30 Oct 2015 12:16:55 +0000 [thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE202394338@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <1442565172-5338-5-git-send-email-matejvido@gmail.com>
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Matej Vido
> Sent: Friday, September 18, 2015 9:33 AM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH v2 4/5] doc: add documentation for szedata2 PMD
>
> Signed-off-by: Matej Vido <matejvido@gmail.com>
> Reviewed-by: Jan Viktorin <viktorin@rehivetech.com>
Hi,
Thanks for the new PMD and the documentation.
The DPDJ documentation guidelines provide some guidance on how to format and build the DPDK documentation:
http://dpdk.org/doc/guides/contributing/documentation.html
In terms of documentation for a PMD the Mellanox MLX4 docs are a good example:
http://dpdk.org/doc/guides/nics/mlx4.html
Some other comments below:
> +SZEDATA2 PMD
> +============
No need for an acronym in the title. Follow the MLX4 example and use something like " SZEDATA2 poll mode driver library".
> +SZEDATA2 PMD is virtual PMD which uses sze2 layer to communicate with
> +COMBO cards (COMBO-80G, COMBO-100G) using interface provided by libsze2
> library.
The introduction can be brief but should include enough information to explain the PMD for someone encountering it for the first time.
Some links would help with this. See the MLX4 doc as an example:
> +
> +.. note::
> +
> + This driver has external dependencies. Therefore it is disabled in
> default
> + configuration files. It can be enabled by setting
> CONFIG_RTE_LIBRTE_PMD_SZEDATA2=y
Format configuration items as verbatim text with double backquotes:`` CONFIG_RTE_LIBRTE_PMD_SZEDATA2=y ``
> +
> +Using PMD
> +---------
Better: Using the Szedata PMD
> +
> +SZEDATA2 PMD can be created by passing --vdev= option to EAL in the
Again format --vdev as ``--vdev``. Also apply to other similar cases.
> +following format:
> +
> +.. code-block:: console
> +
> + --vdev
> 'DEVICE_NAME,dev_path=PATH_TO_SZEDATA2_DEVICE,rx_ifaces=RX_MASK,tx_ifaces=
> TX_MASK'
This code line exceeds 80 chars and will exceed the page width in the PDF docs. If possible see if it can be shortened. Maybe use DEVICE instead of DEVICE_NAME and PATH instead of PATH_TO. The next section has an explanation anyway.
> +
> +DEVICE_NAME and options dev_path, rx_ifaces, tx_ifaces are mandatory
> +and must be separated by commas.
Use the ```` quotes again.
> +
> +* DEVICE_NAME: contains prefix eth_szedata2 followed by numbers or
> letters,
> + must be unique for each virtual device
> +
> +* dev_path: Defines path to szedata2 device.
> + Value is valid path to szedata2 device.
> +
> + dev_path=/dev/szedataII0
Code blocks should be prefixed by :: to render them correctly. See the guidelines and also view the output from "make doc-guides-html".
Same for the other items below.
> +
> +Example of usage
> +^^^^^^^^^^^^^^^^
The convention is to use ~~~~~ for third level headings (see the guidelines). However, this could probably be a second level heading.
> +
> +Read packets from 0. and 1. receive channel and write them to 0. and 1.
> +transmit channel
> +
> +.. code-block:: console
> +
> + $RTE_TARGET/app/testpmd -c 0xf -n 2 --vdev
> + 'eth_szedata20,dev_path=/dev/szedataII0,rx_ifaces=0x3,tx_ifaces=0x3'
> + -- --port-topology=chained --rxq=2 --txq=2 --nb-cores=2
Again this code line is >80 chars and won't look good in the PDF. I'd suggest the following:
testpmd -c 0xf -n 2 \
--vdev 'eth_szedata20,dev_path=/dev/szedataII0,rx_ifaces=3,tx_ifaces=3' \
-- --port-topology=chained --rxq=2 --txq=2 --nb-cores=2
> diff --git a/doc/guides/prog_guide/source_org.rst
> b/doc/guides/prog_guide/source_org.rst
> index ae11b3b..2393002 100644
> --- a/doc/guides/prog_guide/source_org.rst
> +++ b/doc/guides/prog_guide/source_org.rst
> @@ -106,6 +106,7 @@ The drivers directory has a *net* subdirectory which
> contains::
> +-- null # NULL poll mode driver for testing
> +-- pcap # PCAP poll mode driver
> +-- ring # Ring poll mode driver
> + +-- szedata2 # szedata2 poll mode driver
> +-- virtio # Virtio poll mode driver
> +-- vmxnet3 # VMXNET3 poll mode driver
> +-- xenvirt # Xen virtio poll mode driver
It isn't necessary to update this section. It is meant to be representative rather than comprehensive (at least to me). However if you leave it in then captilize the name like the others.
Thanks,
John
next prev parent reply other threads:[~2015-10-30 12:17 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-06-19 8:24 [dpdk-dev] [PATCH 0/2] Virtual PMD using sze2 layer for COMBO cards Matej Vido
2015-06-19 8:25 ` [dpdk-dev] [PATCH 1/2] szedata2: new poll mode driver Matej Vido
2016-03-21 17:45 ` Stephen Hemminger
2016-03-24 17:52 ` Matej Vido
2015-06-19 8:25 ` [dpdk-dev] [PATCH 2/2] doc: added documentation for szedata2 PMD Matej Vido
2015-09-18 8:32 ` [dpdk-dev] [PATCH v2 0/5] Virtual PMD using sze2 layer for COMBO cards Matej Vido
2015-09-18 8:32 ` [dpdk-dev] [PATCH v2 1/5] szedata2: add new poll mode driver Matej Vido
2015-10-26 15:10 ` Thomas Monjalon
2015-09-18 8:32 ` [dpdk-dev] [PATCH v2 2/5] szedata2: add handling of scattered packets in RX Matej Vido
2015-09-18 8:32 ` [dpdk-dev] [PATCH v2 3/5] szedata2: add handling of scattered packets in TX Matej Vido
2015-10-26 14:55 ` Thomas Monjalon
2015-10-27 17:40 ` Matej Vido
2015-09-18 8:32 ` [dpdk-dev] [PATCH v2 4/5] doc: add documentation for szedata2 PMD Matej Vido
2015-10-26 15:00 ` Thomas Monjalon
2015-10-26 15:09 ` Thomas Monjalon
2015-10-27 17:33 ` Matej Vido
2015-10-27 18:00 ` Thomas Monjalon
2015-11-02 14:26 ` Matej Vido
2015-10-30 12:16 ` Mcnamara, John [this message]
2015-11-06 14:34 ` Matej Vido
2015-09-18 8:32 ` [dpdk-dev] [PATCH v2 5/5] doc: update 2.2 release notes Matej Vido
2015-09-24 16:23 ` [dpdk-dev] [PATCH v2] doc: update the dpdk " John McNamara
2015-09-24 21:14 ` Thomas Monjalon
2015-11-10 14:18 ` [dpdk-dev] [PATCH v3 0/6] Virtual PMD using sze2 layer for COMBO cards Matej Vido
2015-11-10 14:18 ` [dpdk-dev] [PATCH v3 1/6] szedata2: add new poll mode driver Matej Vido
2015-11-20 15:04 ` Thomas Monjalon
2015-11-20 19:25 ` Matej Vido
2015-11-21 10:27 ` Thomas Monjalon
2015-11-10 14:18 ` [dpdk-dev] [PATCH v3 2/6] szedata2: add non-scattered RX function Matej Vido
2015-11-10 14:18 ` [dpdk-dev] [PATCH v3 3/6] szedata2: add TX function Matej Vido
2015-11-10 14:18 ` [dpdk-dev] [PATCH v3 4/6] szedata2: add support for scattered packets in RX Matej Vido
2015-11-10 14:18 ` [dpdk-dev] [PATCH v3 5/6] doc: add documentation for szedata2 PMD Matej Vido
2015-11-10 14:55 ` Mcnamara, John
2015-11-10 14:18 ` [dpdk-dev] [PATCH v3 6/6] doc: update 2.2 release notes Matej Vido
2015-11-16 14:22 ` Mcnamara, John
2015-11-20 16:19 ` [dpdk-dev] [PATCH v3 0/6] Virtual PMD using sze2 layer for COMBO cards Thomas Monjalon
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=B27915DBBA3421428155699D51E4CFE202394338@IRSMSX103.ger.corp.intel.com \
--to=john.mcnamara@intel.com \
--cc=dev@dpdk.org \
--cc=matejvido@gmail.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).