From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by dpdk.org (Postfix) with ESMTP id 6F0FA2B96 for ; Tue, 26 Apr 2016 17:49:42 +0200 (CEST) Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by orsmga103.jf.intel.com with ESMTP; 26 Apr 2016 08:49:41 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.24,537,1455004800"; d="scan'208";a="953312835" Received: from irsmsx109.ger.corp.intel.com ([163.33.3.23]) by fmsmga001.fm.intel.com with ESMTP; 26 Apr 2016 08:49:39 -0700 Received: from irsmsx111.ger.corp.intel.com (10.108.20.4) by IRSMSX109.ger.corp.intel.com (163.33.3.23) with Microsoft SMTP Server (TLS) id 14.3.248.2; Tue, 26 Apr 2016 16:49:38 +0100 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.12]) by irsmsx111.ger.corp.intel.com ([169.254.2.16]) with mapi id 14.03.0248.002; Tue, 26 Apr 2016 16:49:38 +0100 From: "Mcnamara, John" To: Rasesh Mody , "thomas.monjalon@6wind.com" , "Richardson, Bruce" CC: "dev@dpdk.org" , "ameen.rahman@qlogic.com" , Harish Patil , "Sony Chacko" Thread-Topic: [dpdk-dev] [PATCH v6 1/8] qede: Add maintainers, documentation and license Thread-Index: AQHRn3peUNmaearnpUegLlbD6lJZQ5+cZGcg Date: Tue, 26 Apr 2016 15:49:38 +0000 Message-ID: References: <1461647586-22234-1-git-send-email-rasesh.mody@qlogic.com> In-Reply-To: <1461647586-22234-1-git-send-email-rasesh.mody@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: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiNDdkNzAzZWItMTNiMC00ZDNmLTgwY2MtZTRhZTEzMGY1M2NmIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE1LjkuNi42IiwiVHJ1c3RlZExhYmVsSGFzaCI6IlYyZzlaK2dONTUrNnFyQmhYT2N3K2ZyYlpQekVESVpOZkd5VTk1cVd5OUU9In0= x-originating-ip: [163.33.239.180] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH v6 1/8] qede: Add maintainers, documentation and license 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: Tue, 26 Apr 2016 15:49:43 -0000 Hi, Thanks for the documentation.=20 In general you should generate and view the Html output to make sure everything is okay: make doc-guides-html=20 firefox build/doc/html/guides/nics/qede.html & Other comments below. > -----Original Message----- > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Rasesh Mody > Sent: Tuesday, April 26, 2016 6:13 AM > To: thomas.monjalon@6wind.com; Richardson, Bruce > > Cc: dev@dpdk.org; ameen.rahman@qlogic.com; Rasesh Mody > ; Harish Patil ; Sony > Chacko > Subject: [dpdk-dev] [PATCH v6 1/8] qede: Add maintainers, documentation > and license >=20 > ... > > + > +Prerequisites > +------------- > + > +- Requires firmware version **8.7.x. ** and management Omit the space before the second "**" bold or it won't render properly. > + firmware version **8.7.x or higher**. Firmware may be available > + inbox in certain newer Linux distros under the standard directory > + E.g. /lib/firmware/qed/qed_init_values_zipped-8.7.7.0.bin Paths should be wrapped in fixed ```` quotes. > + > +- If the required firmware files are not available then visit > + `QLogic Driver Download Center ` The link requires a _ at the end to render correctly, and a full stop at the end would be better as well. > +- ``CONFIG_RTE_LIBRTE_QEDE_FW`` (default **""**) > + > + Gives absolute path of firmware file. > + Eg: "/lib/firmware/qed/qed_init_values_zipped-8.7.7.0.bin" Paths should be wrapped in fixed ```` quotes. > + Empty string indicates driver will pick up the firmware file from > + the default location. > + > +Driver Compilation > +~~~~~~~~~~~~~~~~~~ > + > +To compile QEDE PMD for Linux x86_64 gcc target, run the following "make= " > +command:: Commands like "make" and constants should be wrapped in fixed ```` quotes. > + > +#. Bind the QLogic 4xxxx adapters to ``igb_uio`` loaded in the > + previous step:: > + > + .. code-block:: console > + ./tools/dpdk_nic_bind.py --bind igb_uio 0000:84:00.0 0000:84:00.1 = \ The :: after step is overriding/confusing the ::console directive. Use ore or the other. Also there should be a blank line between ::console and the text. > + > +**Note**: librte_pmd_qede will be used to bind to SR-IOV VF device and > + Linux native kernel driver (QEDE) will function as SR-IOV PF The second line of the note shouldn't be indented or else it doesn't render correctly. Alternatively, you could use a real RST note: .. Note:: Some text here indent 3 spaces. + > + Assign MAC address to the VF using iproute2 utility. The syntax is:: > + ip link set vf mac > + There should be a blank line between :: and the text. John. --=20