[dpdk-dev] [PATCH v3 3/4] net/netvsc: add documentation

[Ferruh Yigit]

On 4/17/2018 10:53 PM, Stephen Hemminger wrote:
> Matching documentation for new netvsc device.
> 
> Signed-off-by: Stephen Hemminger <sthemmin at microsoft.com>
> ---
>  doc/guides/nics/index.rst              |  1 +
>  doc/guides/nics/netvsc.rst             | 97 ++++++++++++++++++++++++++
>  doc/guides/rel_notes/release_18_05.rst |  6 ++
>  3 files changed, 104 insertions(+)
>  create mode 100644 doc/guides/nics/netvsc.rst

Documentation added for network driver but not for bus driver, does it make
sense to add vmbus doc too?

<...>

> diff --git a/doc/guides/rel_notes/release_18_05.rst b/doc/guides/rel_notes/release_18_05.rst
> index bc9cdda6af7a..0a7b65d49293 100644
> --- a/doc/guides/rel_notes/release_18_05.rst
> +++ b/doc/guides/rel_notes/release_18_05.rst
> @@ -115,6 +115,12 @@ New Features
>  
>    Linux uevent is supported as backend of this device event notification framework.
>  
> +* **Added experimental support for Hyper-V netvsc PMD.**
> +
> +  The new experimntal ``netvsc`` poll mode driver provides native support for
> +  networking on Hyper-V. See the :doc:`../nics/netvsc` nic driver guide
> +  for more details on this   new driver.
> +

Also there is a "Shared Library Versions" section of the release notes, the
libraries with public API should be listed here with version information. I can
see some bus libraries are there.

If any of the libraries added has public API, should be added into that list.