[dpdk-dev] [PATCH v9 6/6] doc: update docs for ntb driver

Thomas Monjalon thomas at monjalon.net
Mon Jul 1 16:24:27 CEST 2019


28/06/2019 04:53, Xiaoyun Li:
> +NTB Rawdev
> +M: Xiaoyun Li <xiaoyun.li at intel.com>
> +M: Jingjing Wu <jingjing.wu at intel.com>
> +F: drivers/raw/ntb_rawdev/
> +F: doc/guides/rawdevs/ntb_rawdev.rst

Please update MAINTAINERS while introducing files in previous patches.

> +++ b/doc/guides/rawdevs/ntb_rawdev.rst
> +And this PMD only supports intel skylake platform.

I guess the platform name require some uppercase or other characters.
Please request a full review of the doc by Intel colleagues.

> --- a/doc/guides/rel_notes/release_19_08.rst
> +++ b/doc/guides/rel_notes/release_19_08.rst
> +* **Introduced NTB PMD.**
> +
> +  The PMD provided a non-transparent bridge between two separate hosts so
> +  that they can communicate with each other. Thus, many user cases can
> +  benefit from this, such as fault tolerance and visual acceleration.
> +
> +  This PMD implemented the following features:
> +  * Handshake for device start and stop between two hosts.
> +  * Memory allocation for the peer to access and read/write allocated
> +    memory from peer.
> +  * Use doorbell registers to notify the peer and share some information
> +    by using scratchpad registers.
> +
> +  But the PMD hasn't implemented FIFO. The FIFO will come in 19.11 release.
> +  And this PMD only supports intel skylake platform.

You don't need to repeat the full doc in the release notes.
Please make it shorter.
And please update the release notes in the same patch as the code.

Thanks




More information about the dev mailing list