[dpdk-dev] [PATCH v2] doc: update release notes for 17.05

Shreyansh Jain shreyansh.jain at nxp.com
Wed May 10 06:59:51 CEST 2017


Hello John,

Some super trivial comments inline:

On Tuesday 09 May 2017 10:26 PM, John McNamara wrote:
> Fix grammar, spelling and formatting of DPDK 17.05 release notes.
>
> Signed-off-by: John McNamara <john.mcnamara at intel.com>
> ---
>
> V2: Added updated MLX4/5 text. This patch supercedes patch 24166.
>
>  doc/guides/rel_notes/release_17_05.rst | 197 +++++++++++++++------------------
>  1 file changed, 91 insertions(+), 106 deletions(-)
>
> diff --git a/doc/guides/rel_notes/release_17_05.rst b/doc/guides/rel_notes/release_17_05.rst
> index 4b47ae1..f911711 100644
> --- a/doc/guides/rel_notes/release_17_05.rst
> +++ b/doc/guides/rel_notes/release_17_05.rst
> @@ -41,16 +41,18 @@ New Features
>       Also, make sure to start the actual text at the margin.
>       =========================================================
>
> -* **Reorganized the mbuf structure.**
> +* **Reorganized mbuf structure.**
> +
> +  The mbuf structure has been reorganized as follows:
>
>    * Align fields to facilitate the writing of ``data_off``, ``refcnt``, and
>      ``nb_segs`` in one operation.
>    * Use 2 bytes for port and number of segments.
> -  * Move the sequence number in the second cache line.
> +  * Move the sequence number to the second cache line.
>    * Add a timestamp field.
>    * Set default value for ``refcnt``, ``next`` and ``nb_segs`` at mbuf free.
>
> -* **Added mbuf raw free API**
> +* **Added mbuf raw free API.**
>
>    Moved ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()`` functions to
>    the public API.
> @@ -58,14 +60,14 @@ New Features
>  * **Added free Tx mbuf on demand API.**
>
>    Added a new function ``rte_eth_tx_done_cleanup()`` which allows an application
> -  to request the driver to release mbufs from their Tx ring that are no longer
> -  in use, independent of whether or not the ``tx_rs_thresh`` has been crossed.
> +  to request the driver to release mbufs from that are no longer in use from a

isn't the 'that' in '..mbufs from that are no...' above extra?

> +  Tx ring, independent of whether or not the ``tx_rs_thresh`` has been crossed.
>
>  * **Added device removal interrupt.**
>
>    Added a new ethdev event ``RTE_ETH_DEV_INTR_RMV`` to signify
>    the sudden removal of a device.
> -  This event can be advertized by PCI drivers and enabled accordingly.
> +  This event can be advertised by PCI drivers and enabled accordingly.
>
>  * **Added EAL dynamic log framework.**
>
> @@ -77,25 +79,25 @@ New Features

[...]

>  * **Updated the ixgbe base driver.**
> @@ -106,64 +108,62 @@ New Features
>    * Complete HW initialization even if SFP is not present.
>    * Add VF xcast promiscuous mode.
>
> -* **Added powerpc support for i40e and its vector PMD .**
> +* **Added PowerPC support for i40e and its vector PMD.**
>
> -  i40e PMD and its vector PMD enabled by default in powerpc.
> +  Enabled i40e PMD and its vector PMD by default in PowerPC.
>
>  * **Added VF max bandwidth setting on i40e.**
>
> -  i40e HW supports to set the max bandwidth for a VF. Enable this capability.
> -
> -* **Added VF TC min bandwidth setting on i40e.**
> -
> -  i40e HW supports to set the allocated bandwidth for a TC on a VF. Enable this
> -  capability.
> +  Enabled capability to set the max bandwidth for a VF, in i40e.

I think the ',' in "... , in i40e" is unnecessary.
But, I am not grammatically perfect either - so, maybe it is OK.

>
> -* **Added VF TC max bandwidth setting on i40e.**
> +* **Added VF TC min and max bandwidth setting on i40e.**
>
> -  i40e HW supports to set the max bandwidth for a TC on a VF. Enable this
> -  capability.
> +  Enabled capability to set the min and max allocated bandwidth for a TC on a
> +  VF, in i40.

Same as above: an extra ','.

>
>  * **Added TC strict priority mode setting on i40e.**
>
> -  There're 2 TX scheduling modes supported for TCs by i40e HW, round ribon mode
> -  and strict priority mode. By default it's round robin mode. Enable the
> -  capability to change the TX scheduling mode for a TC. It's a global setting
> -  on a physical port.
> +  There are 2 Tx scheduling modes supported for TCs by i40e HW, round robin

It should be "...by i40w HW: round robin .."; ':' rather than ','.

> +  mode and strict priority mode. By default the round robin mode is used. It
> +  is now possible to change the Tx scheduling mode for a TC. This is a global
> +  setting on a physical port.
>

[...]

>
>  * **Added support for NXP DPAA2 - FSLMC bus.**
>
>    Added the new bus "fslmc" driver for NXP DPAA2 devices. See the
> -  "Network Interface Controller Drivers" document for more details on this new
> +  "Network Interface Controller Drivers" document for more details of this new
>    driver.
>
>  * **Added support for NXP DPAA2 Network PMD.**
>
>    Added the new "dpaa2" net driver for NXP DPAA2 devices. See the
> -  "Network Interface Controller Drivers" document for more details on this new
> +  "Network Interface Controller Drivers" document for more details of this new
>    driver.

As one of the author of NXP Bus/PMD, I am OK with above change.
Acked-By: Shreyansh Jain <shreyansh.jain at nxp.com>

<...>

-
Shreyansh



More information about the dev mailing list