* [dpdk-dev] [PATCH v1] doc: fix release notes for 16.04
@ 2016-04-07 16:02 John McNamara
2016-04-07 16:54 ` Thomas Monjalon
0 siblings, 1 reply; 2+ messages in thread
From: John McNamara @ 2016-04-07 16:02 UTC (permalink / raw)
To: dev; +Cc: thomas.monjalon, John McNamara
Fix grammar, spelling and formatting of DPDK 16.04 release notes.
Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
doc/guides/rel_notes/release_16_04.rst | 266 +++++++++++++--------------------
1 file changed, 104 insertions(+), 162 deletions(-)
diff --git a/doc/guides/rel_notes/release_16_04.rst b/doc/guides/rel_notes/release_16_04.rst
index e293960..200053c 100644
--- a/doc/guides/rel_notes/release_16_04.rst
+++ b/doc/guides/rel_notes/release_16_04.rst
@@ -2,39 +2,9 @@ DPDK Release 16.04
==================
-**Read this first**
-
-The text below explains how to update the release notes.
-
-Use proper spelling, capitalization and punctuation in all sections.
-
-Variable and config names should be quoted as fixed width text: ``LIKE_THIS``.
-
-Build the docs and view the output file to ensure the changes are correct::
-
- make doc-guides-html
-
- firefox build/doc/html/guides/rel_notes/release_16_04.html
-
-
New Features
------------
-This section should contain new features added in this release. Sample format:
-
-* **Add a title in the past tense with a full stop.**
-
- Add a short 1-2 sentence description in the past tense. The description
- should be enough to allow someone scanning the release notes to understand
- the new feature.
-
- If the feature adds a lot of sub-features you can use a bullet list like this.
-
- * Added feature foo to do something.
- * Enhanced feature bar to do something else.
-
- Refer to the previous release notes for examples.
-
* **Added function to check primary process state.**
A new function ``rte_eal_primary_proc_alive()`` has been added
@@ -45,141 +15,145 @@ This section should contain new features added in this release. Sample format:
* **Enabled bulk allocation of mbufs.**
A new function ``rte_pktmbuf_alloc_bulk()`` has been added to allow the user
- to allocate a bulk of mbufs.
+ to bulk allocate mbufs.
* **Added device link speed capabilities.**
- The structure ``rte_eth_dev_info`` has now a ``speed_capa`` bitmap, which
- allows the application to know the supported speeds of each device.
+ The structure ``rte_eth_dev_info`` now has a ``speed_capa`` bitmap, which
+ allows the application to determine the supported speeds of each device.
* **Added bitmap of link speeds to advertise.**
- Allow defining a set of advertised speeds for auto-negotiation,
+ Added a feature to allow the definition of a set of advertised speeds for auto-negotiation,
explicitly disabling link auto-negotiation (single speed)
and full auto-negotiation.
* **Added new poll-mode driver for Amazon Elastic Network Adapters (ENA).**
- The driver operates variety of ENA adapters through feature negotiation
+ The driver operates for a variety of ENA adapters through feature negotiation
with the adapter and upgradable commands set.
- ENA driver handles PCI Physical and Virtual ENA functions.
+ The ENA driver handles PCI Physical and Virtual ENA functions.
-* **Restored vmxnet3 Tx data ring.**
+* **Restored vmxnet3 TX data ring.**
- Tx data ring has been shown to improve small pkt forwarding performance
- on vSphere environment.
+ TX data ring has been shown to improve small packet forwarding performance
+ on the vSphere environment.
-* **Added vmxnet3 Tx L4 checksum offload.**
+* **Added vmxnet3 TX L4 checksum offload.**
- Support TCP/UDP checksum offload.
+ Added support for TCP/UDP checksum offload to vmxnet3.
* **Added vmxnet3 TSO support.**
+ Added support for TSO to vmxnet3.
+
* **Added vmxnet3 support for jumbo frames.**
Added support for linking multi-segment buffers together to
handle Jumbo packets.
-* **Virtio 1.0.**
+* **Enabled Virtio 1.0 support.**
- Enabled virtio 1.0 support for virtio pmd driver.
+ Enabled Virtio 1.0 support for Virtio pmd driver.
-* **Supported virtio for ARM.**
+* **Supported Virtio for ARM.**
- Enabled virtio support for armv7/v8. Tested for arm64.
- Virtio for arm support VFIO-noiommu mode only.
- Virtio can work with other non-x86 arch too like powerpc.
+ Enabled Virtio support for ARMv7/v8. Tested for ARM64.
+ Virtio for ARM supports VFIO-noiommu mode only.
+ Virtio can work with other non-x86 architectures as well, like PowerPC.
-* **Supported virtio offload in vhost-user.**
+* **Supported Virtio offload in vhost-user.**
- Add the offload and negotiation of checksum and TSO between vhost-user and
- vanilla Linux virtio guest.
+ Added the offload and negotiation of checksum and TSO between vhost-user and
+ vanilla Linux Virtio guest.
* **Added vhost-user live migration support.**
* **Added vhost driver.**
- Added virtual PMD that wraps librte_vhost.
+ Added a virtual PMD that wraps ``librte_vhost``.
* **Added multicast promiscuous mode support on VF for ixgbe.**
- Added multicast promiscuous mode support on ixgbe VF driver. So all the VFs
+ Added multicast promiscuous mode support for the ixgbe VF driver so all VFs
can receive the multicast packets.
- Please note if we want to use this promiscuous mode, we need both PF and VF
- driver to support it. The reason is this VF feature is configured on PF.
- If use kernel PF driver + dpdk VF driver, make sure kernel PF driver support
- VF multicast promiscuous mode. If use dpdk PF + dpdk VF, better make sure PF
- driver is the same version as VF.
+ Please note if you want to use this promiscuous mode, you need both PF and VF
+ driver to support it. The reason is that this VF feature is configured in the PF.
+ If you use kernel PF driver and the dpdk VF driver, make sure the kernel PF driver supports
+ VF multicast promiscuous mode. If you use dpdk PF and dpdk VF ensure the PF
+ driver is the same version as the VF.
* **Added support for E-tag on X550.**
- E-tag is defined in 802.1br. Please reference
- http://www.ieee802.org/1/pages/802.1br.html.
+ E-tag is defined in `802.1BR - Bridge Port Extension <http://www.ieee802.org/1/pages/802.1br.html>`_.
- This feature is for VF, but the settings are on PF. It means
- the CLIs should be used on PF, but some of their effects will be shown on VF.
- The forwarding of E-tag packets based on GRP and E-CID_base will have effect
- on PF. Theoretically the E-tag packets can be forwarded to any pool/queue.
- But normally we'd like to forward the packets to the pools/queues belonging
- to the VFs. And E-tag insertion and stripping will have effect on VFs. When
- VF receives E-tag packets, it should strip the E-tag. When VF transmits
- packets, it should insert the E-tag. Both can be offloaded.
+ This feature is for the VF, but the settings are on the PF. It means
+ the CLIs should be used on the PF, but some of their effects will be shown on the VF.
+ The forwarding of E-tag packets based on GRP and E-CID_base will have an effect
+ on the PF. Theoretically, the E-tag packets can be forwarded to any pool/queue
+ but normally we'd like to forward the packets to the pools/queues belonging
+ to the VFs. And E-tag insertion and stripping will have an effect on VFs. When
+ a VF receives E-tag packets it should strip the E-tag. When the VF transmits
+ packets, it should insert the E-tag. Both actions can be offloaded.
When we want to use this E-tag support feature, the forwarding should be
- enabled to forward the packets received by PF to indicated VFs. And insertion
- and stripping should be enabled for VFs to offload the effort to HW.
+ enabled to forward the packets received by the PF to the indicated VFs. And insertion
+ and stripping should be enabled for VFs to offload the effort to hardware.
+
+ Features added:
* Support E-tag offloading of insertion and stripping.
* Support Forwarding E-tag packets to pools based on
GRP and E-CID_base.
-* **Added support for VxLAN & NVGRE checksum off-load on X550.**
+* **Added support for VxLAN and NVGRE checksum off-load on X550.**
- * Added support for VxLAN & NVGRE RX/TX checksum off-load on
+ * Added support for VxLAN and NVGRE RX/TX checksum off-load on
X550. RX/TX checksum off-load is provided on both inner and
outer IP header and TCP header.
* Added functions to support VxLAN port configuration. The
default VxLAN port number is 4789 but this can be updated
programmatically.
-* **Added new X550EM_a devices.**
+* **Added support for new X550EM_a devices.**
- Added new X550EM_a devices and their mac types, X550EM_a and X550EM_a_vf.
- Updated the code to use the new devices and mac types.
+ Added support for new X550EM_a devices and their MAC types, X550EM_a and X550EM_a_vf.
+ Updated the relevant PMD to use the new devices and MAC types.
* **Added x550em_x V2 device support.**
- Only x550em_x V1 was supported before. Now V2 is supported.
+ Added support for x550em_x V2 device. Only x550em_x V1 was supported before.
A mask for V1 and V2 is defined and used to support both.
* **Supported link speed auto-negotiation on X550EM_X**
- Normally the auto-negotiation is supported by FW. SW need not care about
- that. But on x550em_x, FW doesn't support auto-neg. As the ports of x550em_x
- are 10G, if we connect the port with a peer which is 1G, the link will always
+ Normally the auto-negotiation is supported by firmware and software doesn't care about
+ it. But on x550em_x, firmware doesn't support auto-negotiation. As the ports of x550em_x
+ are 10GbE, if we connect the port with a peer which is 1GbE, the link will always
be down.
- We added the support of auto-neg by SW to avoid this link down issue.
+ We added the support for auto-negotiation by software to avoid this link down issue.
-* **Added sw-firmware sync on X550EM_a.**
+* **Added software-firmware sync on X550EM_a.**
- Added support for sw-firmware sync for resource sharing.
- Use the PHY token, shared between sw-fw for PHY access on X550EM_a.
+ Added support for software-firmware sync for resource sharing.
+ Use the PHY token, shared between software-firmware for PHY access on X550EM_a.
* **Updated the i40e base driver.**
The i40e base driver was updated with changes including the
following:
- * Use Rx control AQ commands to read/write Rx control registers.
+ * Use RX control AQ commands to read/write RX control registers.
* Add new X722 device IDs, and removed X710 one was never used.
* Expose registers for HASH/FD input set configuring.
* **Enabled PCI extended tag for i40e.**
- It enabled extended tag by checking and writing corresponding PCI config
- space bytes, to boost the performance. In the meanwhile, it deprecated the
- legacy way via reading/writing sysfile supported by kernel module igb_uio.
+ Enabled extended tag for i40e by checking and writing corresponding PCI config
+ space bytes, to boost the performance.
+ The legacy method of reading/writing sysfile supported by kernel module igb_uio
+ is now deprecated.
* **Added i40e support for setting mac addresses.**
@@ -197,22 +171,22 @@ This section should contain new features added in this release. Sample format:
* **Added PF reset event reporting in i40e VF driver.**
-* **Added fm10k Rx interrupt support.**
+* **Added fm10k RX interrupt support.**
-* **Optimized fm10k Tx.**
+* **Optimized fm10k TX.**
- * Free multiple mbufs at a time to reduce freeing mbuf cycles.
+ Optimized fm10k TX by freeing multiple mbufs at a time.
-* **Handled error flags in fm10k vector Rx.**
+* **Handled error flags in fm10k vector RX.**
- Parse err flags in Rx desc and set error bits in mbuf with vector instructions.
+ Parse error flags in RX descriptor and set error bits in mbuf with vector instructions.
* **Added fm10k FTAG based forwarding support.**
* **Added mlx5 flow director support.**
- Added flow director support (RTE_FDIR_MODE_PERFECT and
- RTE_FDIR_MODE_PERFECT_MAC_VLAN).
+ Added flow director support (``RTE_FDIR_MODE_PERFECT`` and
+ ``RTE_FDIR_MODE_PERFECT_MAC_VLAN``).
Only available with Mellanox OFED >= 3.2.
@@ -238,7 +212,7 @@ This section should contain new features added in this release. Sample format:
* **Added mlx5 optional packet padding by HW.**
- Added an option to make PCI bus transactions rounded to multiple of a
+ Added an option to make PCI bus transactions rounded to a multiple of a
cache line size for better alignment.
Only available with Mellanox OFED >= 3.2.
@@ -249,10 +223,10 @@ This section should contain new features added in this release. Sample format:
Only available with Mellanox OFED >= 3.2.
-* **Changed szedata2 type of driver from vdev to pdev.**
+* **Changed szedata2 driver type from vdev to pdev.**
Previously szedata2 device had to be added by ``--vdev`` option.
- Now szedata2 PMD recognises the device automatically during EAL
+ Now szedata2 PMD recognizes the device automatically during EAL
initialization.
* **Added szedata2 functions for setting link up/down.**
@@ -261,17 +235,17 @@ This section should contain new features added in this release. Sample format:
* **Added af_packet dynamic removal function.**
- Af_packet device can now be detached using API, like other PMD devices.
+ An af_packet device can now be detached using the API, like other PMD devices.
* **Increased number of next hops for LPM IPv4 to 2^24.**
- The next_hop field is extended from 8 bits to 24 bits for IPv4.
+ The ``next_hop`` field has been extended from 8 bits to 24 bits for IPv4.
* **Added support of SNOW 3G (UEA2 and UIA2) for Intel Quick Assist devices.**
- Enabled support for SNOW 3G wireless algorithm for Intel Quick Assist devices.
- Support for cipher only, hash only is also provided
- along with alg-chaining operations.
+ Enabled support for the SNOW 3G wireless algorithm for Intel Quick Assist devices.
+ Support for cipher-only and hash-only is also provided
+ along with algorithm-chaining operations.
* **Added SNOW3G SW PMD.**
@@ -281,31 +255,29 @@ This section should contain new features added in this release. Sample format:
* **Added AES GCM PMD.**
Added new Crypto PMD to support AES-GCM authenticated encryption and
- authenticated decryption in SW.
+ authenticated decryption in software.
* **Added NULL Crypto PMD**
- Added new Crypto PMD to support null crypto operations in SW.
+ Added new Crypto PMD to support null crypto operations in software.
* **Improved IP Pipeline Application.**
The following features have been added to ip_pipeline application;
* Added CPU utilization measurement and idle cycle rate computation.
- * Added link idenfication support through existing port-mask option or by
+ * Added link identification support through existing port-mask option or by
specifying PCI device in every LINK section in the configuration file.
* Added load balancing support in passthrough pipeline.
* **Added IPsec security gateway example.**
- New application implementing an IPsec Security Gateway.
+ Added a new application implementing an IPsec Security Gateway.
Resolved Issues
---------------
-This section should contain bug fixes added to the relevant sections. Sample format:
-
* **code/section: Fixed issue in the past tense with a full stop.**
Add a short 1-2 sentence description of the resolved issue in the past tense.
@@ -313,21 +285,17 @@ This section should contain bug fixes added to the relevant sections. Sample for
Add the entries in alphabetic order in the relevant sections below.
-EAL
-~~~
-
-
Drivers
~~~~~~~
* **ethdev: Fixed overflow for 100Gbps.**
- 100Gbps in Mbps (100000) was exceeding 16-bit max value of ``link_speed``
+ 100Gbps in Mbps (100000) was exceeding the 16-bit max value of ``link_speed``
in ``rte_eth_link``.
* **ethdev: Fixed byte order consistency between fdir flow and mask.**
- Fixed issue in ethdev library that the structure for setting
+ Fixed issue in ethdev library where the structure for setting
fdir's mask and flow entry was not consistent in byte ordering.
* **cxgbe: Fixed crash due to incorrect size allocated for RSS table.**
@@ -338,12 +306,12 @@ Drivers
* **cxgbe: Fixed setting wrong device MTU.**
- Fixed an incorrect device MTU being set due to ethernet header and
+ Fixed an incorrect device MTU being set due to the Ethernet header and
CRC lengths being added twice.
* **ixgbe: Fixed zeroed VF mac address.**
- Resolved an issue where VF mac address is zeroed out in cases where the VF
+ Resolved an issue where the VF MAC address is zeroed out in cases where the VF
driver is loaded while the PF interface is down.
The solution is to only set it when we get an ACK from the PF.
@@ -370,7 +338,7 @@ Drivers
It generates a MAC address for each VFs during PF host initialization,
and keeps the VF MAC address the same among different VF launch.
-* **i40e: Fixed failure of reading/writing Rx control registers.**
+* **i40e: Fixed failure of reading/writing RX control registers.**
Fixed i40e issue of failing to read/write rx control registers when
under stress with traffic, which might result in application launch
@@ -378,14 +346,14 @@ Drivers
* **i40e: Enabled vector driver by default.**
- Previously, vector driver is disabled by default as it cannot fill packet type
- info for l3fwd to work well. Now there is an option for l3fwd to analysis
- packet type softly, so enable vector driver by default.
+ Previously, vector driver was disabled by default as it couldn't fill packet type
+ info for l3fwd to work well. Now there is an option for l3fwd to analyze
+ the packet type so the vector driver is enabled by default.
* **i40e: Fixed link info of VF.**
- Previously, the VF's link speed kept as 10G and status always was up.
- It did not change even the physical link's status changed.
+ Previously, the VF's link speed stayed at 10GbE and status always was up.
+ It did not change even when the physical link's status changed.
Now this issue is fixed to make VF's link info consistent with physical link.
* **mlx5: Fixed possible crash during initialization.**
@@ -394,7 +362,7 @@ Drivers
* **mlx5: Added port type check.**
- Done to prevent port initialization on non-Ethernet link layers and
+ Added port type check to prevent port initialization on non-Ethernet link layers and
to report an error.
* **mlx5: Applied VLAN filtering to broadcast and IPv6 multicast flows.**
@@ -407,10 +375,10 @@ Drivers
* **aesni_mb: Fixed wrong return value when creating a device.**
- cryptodev_aesni_mb_init() was returning the device id of the device created,
- instead of 0 (when success), that rte_eal_vdev_init() expects.
- This made impossible the creation of more than one aesni_mb device
- from command line.
+ The ``cryptodev_aesni_mb_init()`` function was returning the device id of the device created,
+ instead of 0 (on success) that ``rte_eal_vdev_init()`` expects.
+ This made it impossible to create more than one aesni_mb device
+ from the command line.
* **qat: Fixed AES GCM decryption.**
@@ -424,7 +392,7 @@ Libraries
* **hash: Fixed CRC32c hash computation for non multiple of 4 bytes sizes.**
Fix crc32c hash functions to return a valid crc32c value for data lengths
- not multiple of 4 bytes.
+ not a multiple of 4 bytes.
* **hash: Fixed hash library to support multi-process mode.**
@@ -440,7 +408,7 @@ Libraries
``rte_errno`` to ``EEXIST`` when the object name already exists. This is
the behavior described in the API documentation in the header file.
The previous behavior was to return a pointer to the existing object in
- that case, preventing the caller to know if the object had to be freed
+ that case, preventing the caller from knowing if the object had to be freed
or not.
* **lpm: Fixed return value when allocating an existing object.**
@@ -449,7 +417,7 @@ Libraries
``rte_errno`` to ``EEXIST`` when the object name already exists. This is
the behavior described in the API documentation in the header file.
The previous behavior was to return a pointer to the existing object in
- that case, preventing the caller to know if the object had to be freed
+ that case, preventing the caller from knowing if the object had to be freed
or not.
* **librte_port: Fixed segmentation fault for ring and ethdev writer nodrop.**
@@ -468,39 +436,19 @@ Examples
* **l3fwd: Fixed using packet type blindly.**
- l3fwd makes use of packet type information without even query if devices or PMDs
- really set it. For those don't set ptypes, add an option to parse it softly.
+ l3fwd makes use of packet type information without querying if devices or PMDs
+ really set it. For those devices that don't set ptypes, add an option to parse it.
* **examples/vhost: Fixed frequent mbuf allocation failure.**
- vhost-switch often fails to allocate mbuf when dequeue from vring because it
+ The vhost-switch often fails to allocate mbuf when dequeue from vring because it
wrongly calculates the number of mbufs needed.
-Other
-~~~~~
-
-
-Known Issues
-------------
-
-This section should contain new known issues in this release. Sample format:
-
-* **Add title in present tense with full stop.**
-
- Add a short 1-2 sentence description of the known issue in the present
- tense. Add information on any known workarounds.
-
-
API Changes
-----------
-This section should contain API changes. Sample format:
-
-* Add a short 1-2 sentence description of the API change. Use fixed width
- quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
-
-* The ethdev statistics counter imissed is considered to be independent of ierrors.
+* The ethdev statistics counter ``imissed`` is considered to be independent of ``ierrors``.
All drivers are now counting the missed packets only once, i.e. drivers will
not increment ierrors anymore for missed packets.
@@ -524,13 +472,13 @@ This section should contain API changes. Sample format:
* A parameter ``vlan_type`` has been added to the function
``rte_eth_dev_set_vlan_ether_type``.
-* AF_packet device init function is no longer public. Device should be attached
- with API.
+* The af_packet device init function is no longer public. The device should be attached
+ via the API.
* The LPM ``next_hop`` field is extended from 8 bits to 24 bits for IPv4
while keeping ABI compatibility.
-* A new ``rte_lpm_config`` structure is used so LPM library will allocate
+* A new ``rte_lpm_config`` structure is used so the LPM library will allocate
exactly the amount of memory which is necessary to hold application’s rules.
The previous ABI is kept for compatibility.
@@ -542,10 +490,6 @@ This section should contain API changes. Sample format:
ABI Changes
-----------
-* Add a short 1-2 sentence description of the ABI change that was announced in
- the previous releases and made in this release. Use fixed width quotes for
- ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
-
* The RETA entry size in ``rte_eth_rss_reta_entry64`` has been increased
from 8-bit to 16-bit.
@@ -558,8 +502,6 @@ ABI Changes
Shared Library Versions
-----------------------
-Update any library version updated in this release and prepend with a ``+`` sign.
-
The libraries prepended with a plus sign were incremented in this version.
.. code-block:: diff
--
2.5.0
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [dpdk-dev] [PATCH v1] doc: fix release notes for 16.04
2016-04-07 16:02 [dpdk-dev] [PATCH v1] doc: fix release notes for 16.04 John McNamara
@ 2016-04-07 16:54 ` Thomas Monjalon
0 siblings, 0 replies; 2+ messages in thread
From: Thomas Monjalon @ 2016-04-07 16:54 UTC (permalink / raw)
To: John McNamara; +Cc: dev
2016-04-07 17:02, John McNamara:
> Fix grammar, spelling and formatting of DPDK 16.04 release notes.
>
> Signed-off-by: John McNamara <john.mcnamara@intel.com>
Applied, thanks
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2016-04-07 16:54 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2016-04-07 16:02 [dpdk-dev] [PATCH v1] doc: fix release notes for 16.04 John McNamara
2016-04-07 16:54 ` Thomas Monjalon
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).