From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by dpdk.org (Postfix) with ESMTP id CF6E78DED for ; Fri, 30 Oct 2015 13:17:16 +0100 (CET) Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga101.fm.intel.com with ESMTP; 30 Oct 2015 05:17:16 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.20,218,1444719600"; d="scan'208";a="590981818" Received: from irsmsx110.ger.corp.intel.com ([163.33.3.25]) by FMSMGA003.fm.intel.com with ESMTP; 30 Oct 2015 05:17:15 -0700 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.116]) by irsmsx110.ger.corp.intel.com ([169.254.15.151]) with mapi id 14.03.0248.002; Fri, 30 Oct 2015 12:16:55 +0000 From: "Mcnamara, John" To: Matej Vido , "dev@dpdk.org" Thread-Topic: [dpdk-dev] [PATCH v2 4/5] doc: add documentation for szedata2 PMD Thread-Index: AQHQ8ez9GiSb7hmudEKCvWVxL2EvLJ6ELI2Q Date: Fri, 30 Oct 2015 12:16:55 +0000 Message-ID: References: <1434702301-4509-1-git-send-email-vido@cesnet.cz> <1442565172-5338-1-git-send-email-matejvido@gmail.com> <1442565172-5338-5-git-send-email-matejvido@gmail.com> In-Reply-To: <1442565172-5338-5-git-send-email-matejvido@gmail.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: 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] [PATCH v2 4/5] doc: add documentation for szedata2 PMD X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 30 Oct 2015 12:17:17 -0000 > -----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 PM= D >=20 > Signed-off-by: Matej Vido > Reviewed-by: Jan Viktorin Hi, Thanks for the new PMD and the documentation. The DPDJ documentation guidelines provide some guidance on how to format an= d 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 examp= le: http://dpdk.org/doc/guides/nics/mlx4.html Some other comments below: > +SZEDATA2 PMD > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D No need for an acronym in the title. Follow the MLX4 example and use someth= ing 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 expl= ain 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=3Dy Format configuration items as verbatim text with double backquotes:`` CONF= IG_RTE_LIBRTE_PMD_SZEDATA2=3Dy `` > + > +Using PMD > +--------- Better: Using the Szedata PMD > + > +SZEDATA2 PMD can be created by passing --vdev=3D 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=3DPATH_TO_SZEDATA2_DEVICE,rx_ifaces=3DRX_MASK,tx_if= aces=3D > TX_MASK' This code line exceeds 80 chars and will exceed the page width in the PDF d= ocs. If possible see if it can be shortened. Maybe use DEVICE instead of DE= VICE_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=3D/dev/szedataII0 Code blocks should be prefixed by :: to render them correctly. See the guid= elines 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=3D/dev/szedataII0,rx_ifaces=3D0x3,tx_ifaces=3D0= x3' > + -- --port-topology=3Dchained --rxq=3D2 --txq=3D2 --nb-cores=3D2 Again this code line is >80 chars and won't look good in the PDF. I'd sugge= st the following: testpmd -c 0xf -n 2 \ --vdev 'eth_szedata20,dev_path=3D/dev/szedataII0,rx_ifaces=3D3,tx_ifaces= =3D3' \ -- --port-topology=3Dchained --rxq=3D2 --txq=3D2 --nb-cores=3D2 > 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 the= n captilize the name like the others. Thanks, John