[dpdk-dev] [PATCH v2] doc: update i40e PMD to support on windows

[Kadam, Pallavi]

On 2/2/2021 4:21 AM, Ferruh Yigit wrote:
> On 1/26/2021 11:03 PM, Pallavi Kadam wrote:
>> Add documentation to support i40e PMD on Windows.
>> Update the release notes and features list for the same.
>>
>> v2 changes:
>>     - updated doc/guides/nics/features/i40e.ini file
>>     - Replaced the name UIO with NetUIO
>>
>> Signed-off-by: Pallavi Kadam <pallavi.kadam at intel.com>
>> Reviewed-by: Ranjit Menon <ranjit.menon at intel.com>
>
> <...>
>
>> @@ -75,6 +75,18 @@ Prerequisites
>>         * In all cases Intel recommends using Intel Ethernet Optics; 
>> other modules
>>           may function but are not validated by Intel. Contact Intel 
>> for supported media types.
>>   +Windows Prerequisites
>> +---------------------
>> +
>> +- Follow the DPDK `Getting Started Guide for Windows 
>> <https://doc.dpdk.org/guides/windows_gsg/index.html>`_ to setup the 
>> basic DPDK environment.
>> +
>> +- Identify the Intel® Ethernet adapter and get the latest NVM/FW 
>> version.
>> +
>> +- To access any Intel® Ethernet hardware, load the NetUIO driver in 
>> place of existing built-in (inbox) driver.
>> +
>> +- To load NetUIO driver, follow the steps mentioned in `dpdk-kmods 
>> repository
>> + 
>> <https://browse.dpdk.org/dpdk-kmods/commit/?id=e28aabd882798f21b94918d4517621ce9e355269>`_.
>
> Is the intention to reference the 'README.rst'? If so better to 
> provide link for the documentation, instead of a specific commit, like:
> https://git.dpdk.org/dpdk-kmods/tree/windows/README.rst
Thanks, Ferruh. I'll replace the commit link with the README.rst link in v3.
> And for long term, I guess we need a way to host 'dpdk-kmods' repo 
> documentation.
Will discuss this in the community meeting.