Re: [dpdk-dev] [PATCH v6 1/8] qede: Add maintainers, documentation and license

["Mcnamara, John" <john.mcnamara@intel.com>]

Hi,

Thanks for the documentation. 

In general you should generate and view the Html output to make sure
everything is okay:

    make doc-guides-html 
    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
> <bruce.richardson@intel.com>
> Cc: dev@dpdk.org; ameen.rahman@qlogic.com; Rasesh Mody
> <rasesh.mody@qlogic.com>; Harish Patil <harish.patil@qlogic.com>; Sony
> Chacko <sony.chacko@qlogic.com>
> Subject: [dpdk-dev] [PATCH v6 1/8] qede: Add maintainers, documentation
> and license
> 
> ...
>
> +
> +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 <http://driverdownloads.qlogic.com>`

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 <PF iface> vf <VF id> mac <macaddr>
> +

There should be a blank line between :: and the text.

John.
--