From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by dpdk.org (Postfix) with ESMTP id 332942BBE for ; Mon, 22 Feb 2016 17:52:45 +0100 (CET) Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by fmsmga103.fm.intel.com with ESMTP; 22 Feb 2016 08:52:17 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.22,485,1449561600"; d="scan'208";a="908716157" Received: from irsmsx109.ger.corp.intel.com ([163.33.3.23]) by fmsmga001.fm.intel.com with ESMTP; 22 Feb 2016 08:52:15 -0800 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.30]) by IRSMSX109.ger.corp.intel.com ([169.254.13.100]) with mapi id 14.03.0248.002; Mon, 22 Feb 2016 16:52:14 +0000 From: "Mcnamara, John" To: Harish Patil , "dev@dpdk.org" Thread-Topic: [dpdk-dev] [PATCH 2/6] qede: add documentation Thread-Index: AQHRa/UsXvPJPphsaUO0p9lLYe05Rp84RrvA Date: Mon, 22 Feb 2016 16:52:14 +0000 Message-ID: References: <1455982831-21682-1-git-send-email-harish.patil@qlogic.com> <1455982831-21682-3-git-send-email-harish.patil@qlogic.com> In-Reply-To: <1455982831-21682-3-git-send-email-harish.patil@qlogic.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: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiNjc1NjBmZjctNGM0MS00NDhkLTgzNGItOTc5YWYwODYwYjk2IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE1LjkuNi42IiwiVHJ1c3RlZExhYmVsSGFzaCI6IldcLzRLN1pxMVVZcU94VjVmVEdCcUQ5bm9FcGFQS1wvanB3dXhBS1JIYjdMRT0ifQ== x-originating-ip: [163.33.239.182] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Cc: Sony Chacko Subject: Re: [dpdk-dev] [PATCH 2/6] qede: add documentation 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: Mon, 22 Feb 2016 16:52:45 -0000 > -----Original Message----- > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Harish Patil > Sent: Saturday, February 20, 2016 3:40 PM > To: dev@dpdk.org > Cc: Sony Chacko > Subject: [dpdk-dev] [PATCH 2/6] qede: add documentation >=20 > Signed-off-by: Harish Patil > Signed-off-by: Rasesh Mody > Signed-off-by: Sony Chacko > --- > doc/guides/nics/index.rst | 1 + > doc/guides/nics/qede.rst | 344 Hi, Thanks for the docs. The overall format and content seem good. A few comments below. > +#. Bind the QLogic 579xx adapters to ``igb_uio`` or ``vfio-pci`` loaded > in the > + previous step:: > + > + ./tools/dpdk_nic_bind.py --bind igb_uio 0000:84:00.0 0000:84:00.1 > + 0000:84:00.2 0000:84:00.3 Fixed width lines should be constrained to 80 characters or else they will go off the page in the PDF docs. The usual workaround is to use a command- line continuation (or text wrap). For example: ./tools/dpdk_nic_bind.py --bind igb_uio \ 0000:84:00.0 0000:84:00.1 \ 0000:84:00.2 0000:84:00.3 Or similar. This also applies to the command-lines in other sections. > + > +#. Start ``testpmd`` with basic parameters: > + > + .. code-block:: console > + > + testpmd -c 0xf8000 -n 4 -- -i --nb-cores=3D4 --portmask=3D0xf > + --rxd=3D4096 --txd=3D4096 --txfreet=3D4068 --rxq=3D2 --txq=3D2 --rss-ip > + --rss-udp Same comment about using continuations. > + > + [...] > + > + EAL: PCI device 0000:84:00.0 on NUMA socket 1 > + EAL: probe driver: 1077:1634 rte_qede_pmd Align the text in this section to the same level of indentation. > + EAL: Not managed by a supported kernel driver, skipped > + EAL: PCI device 0000:84:00.1 on NUMA socket 1 > + EAL: probe driver: 1077:1634 rte_qede_pmd > + EAL: Not managed by a supported kernel driver, skipped > + EAL: PCI device 0000:88:00.0 on NUMA socket 1 > + EAL: probe driver: 1077:1656 rte_qede_pmd > + EAL: PCI memory mapped at 0x7f738b200000 > + EAL: PCI memory mapped at 0x7f738b280000 > + EAL: PCI memory mapped at 0x7f738b300000 > + [QEDE PMD: (88:00.0:dpdk-port-0)]qed_load_firmware_data: Loading the > firmware file /lib/firmware/qed/qed_init_values_zipped.bin... Again, try wrap the code/console section at 80 chars in some way that still maintains the meaning. Maybe something like the following (with a note to say that the text has been wrapped for clarity): [QEDE PMD: (88:00.0:dpdk-port-0)]qed_load_firmware_data: Loading the firmware file /lib/firmware/qed/qed_init_values_zipped.bin... [QEDE PMD: (88:00.0:dpdk-port-0)] qede_print_adapter_info:Chip details - BB1 [QEDE PMD: (88:00.0:dpdk-port-0)] qede_print_adapter_info:Driver version:QEDE PMD 8.7.9.0_1.0.= 0 [QEDE PMD: (88:00.0:dpdk-port-0)] qede_print_adapter_info:Firmware version:8.7.7.0 You can test the PDF output as follows: make -j doc-guides-pdf pdf_veiwer build/doc/pdf/guides/nics.pdf John