[dpdk-dev] [PATCH v8 4/4] doc: update with link changes
On 18 February 2016 at 19:14, Mcnamara, John wrote: > Hi, > > Some minor comments below in order to get a consistent set of release > notes. > > > -Original Message- > > From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Marc Sune > > Sent: Sunday, February 14, 2016 10:18 PM > > To: dev at dpdk.org; Lu, Wenzhuo ; Zhang, Helin > > ; Harish Patil ; Chen, > > Jing D > > Subject: [dpdk-dev] [PATCH v8 4/4] doc: update with link changes > > > > Add new features, ABI changes and resolved issues notice for the > > refactored link patch. > > > > Signed-off-by: Marc Sune > > --- > > doc/guides/rel_notes/release_2_3.rst | 102 > > This should be rebased and the notes added to > doc/guides/rel_notes/release_16_04.rst. > > > > + > > +* **ethdev: define a set of advertised link speeds.** > > The title and the text should be in the past tense. > > > See the hints/guidelines in the updated release notes: > > > http://dpdk.org/browse/dpdk/tree/doc/guides/rel_notes/release_16_04.rst > > > > + > > + Allowing to define a set of advertised speeds for auto-negociation, > > Maybe something like: Added functionality to allow the definition of > advertised speeds for ... > > > > > +* **ethdev: add speed_cap bitmap to recover eth device link speed > > +capabilities > > + define a set of advertised link speeds.** > > The title is a little long. Just give a brief overview here and more the > detail > to the text sections. > > > + > > + ``struct rte_eth_dev_info`` has now speed_cap bitmap, which allows > > + the application to recover the supported speeds for that ethernet > > device. > > It would be good to use quotes on speed_cap as well for consistency. > > > + > > +Examples > > + > > + > > +* New API call, rte_eth_speed_to_bm_flag(), in ethdev to map numerical > > +speeds to bitmap fields. > > I don't think this should be in the "Examples" section. Maybe as a sub-item > in the "New Featrues" or in "API Changes" if it is a change. > > > + > > +ABI Changes > > +--- > > + > > +* The ethdev rte_eth_link and rte_eth_conf structures were changed to > > + support the new link API, as well as ETH_LINK_HALF/FULL_DUPLEX. > > + > > +* The ethdev rte_eth_dev_info was changed to support device speed > > capabilities. > > Better to put the struct names and variables in quotes. > > Thanks, > Noted and fixed in v9. Thanks marc > > John. > - > > > >
[dpdk-dev] [PATCH v8 4/4] doc: update with link changes
Hi, Some minor comments below in order to get a consistent set of release notes. > -Original Message- > From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Marc Sune > Sent: Sunday, February 14, 2016 10:18 PM > To: dev at dpdk.org; Lu, Wenzhuo ; Zhang, Helin > ; Harish Patil ; Chen, > Jing D > Subject: [dpdk-dev] [PATCH v8 4/4] doc: update with link changes > > Add new features, ABI changes and resolved issues notice for the > refactored link patch. > > Signed-off-by: Marc Sune > --- > doc/guides/rel_notes/release_2_3.rst | 102 This should be rebased and the notes added to doc/guides/rel_notes/release_16_04.rst. > + > +* **ethdev: define a set of advertised link speeds.** The title and the text should be in the past tense. See the hints/guidelines in the updated release notes: http://dpdk.org/browse/dpdk/tree/doc/guides/rel_notes/release_16_04.rst > + > + Allowing to define a set of advertised speeds for auto-negociation, Maybe something like: Added functionality to allow the definition of advertised speeds for ... > +* **ethdev: add speed_cap bitmap to recover eth device link speed > +capabilities > + define a set of advertised link speeds.** The title is a little long. Just give a brief overview here and more the detail to the text sections. > + > + ``struct rte_eth_dev_info`` has now speed_cap bitmap, which allows > + the application to recover the supported speeds for that ethernet > device. It would be good to use quotes on speed_cap as well for consistency. + > +Examples > + > + > +* New API call, rte_eth_speed_to_bm_flag(), in ethdev to map numerical > +speeds to bitmap fields. I don't think this should be in the "Examples" section. Maybe as a sub-item in the "New Featrues" or in "API Changes" if it is a change. > + > +ABI Changes > +--- > + > +* The ethdev rte_eth_link and rte_eth_conf structures were changed to > + support the new link API, as well as ETH_LINK_HALF/FULL_DUPLEX. > + > +* The ethdev rte_eth_dev_info was changed to support device speed > capabilities. Better to put the struct names and variables in quotes. Thanks, John. -
[dpdk-dev] [PATCH v8 4/4] doc: update with link changes
Add new features, ABI changes and resolved issues notice for the refactored link patch. Signed-off-by: Marc Sune --- doc/guides/rel_notes/release_2_3.rst | 102 +++ 1 file changed, 102 insertions(+) create mode 100644 doc/guides/rel_notes/release_2_3.rst diff --git a/doc/guides/rel_notes/release_2_3.rst b/doc/guides/rel_notes/release_2_3.rst new file mode 100644 index 000..b10c3bb --- /dev/null +++ b/doc/guides/rel_notes/release_2_3.rst @@ -0,0 +1,102 @@ +DPDK Release 2.3 + + +New Features + + +* **ethdev: define a set of advertised link speeds.** + + Allowing to define a set of advertised speeds for auto-negociation, + explicitely disable link auto-negociation (single speed) and full + auto-negociation. + +* **ethdev: add speed_cap bitmap to recover eth device link speed capabilities + define a set of advertised link speeds.** + + ``struct rte_eth_dev_info`` has now speed_cap bitmap, which allows the + application to recover the supported speeds for that ethernet device. + + +Resolved Issues +--- + +* **ethdev: Fixed link_speed overflow in rte_eth_link for 100Gbps.** + + 100Gbps in Mbps (10) exceeds 16 bit max value of ``link_speed`` in + ``rte_eth_link``. + + +EAL +~~~ + + +Drivers +~~~ + + +Libraries +~ + + +Examples + + +* New API call, rte_eth_speed_to_bm_flag(), in ethdev to map numerical speeds + to bitmap fields. + + +Other +~ + + +Known Issues + + + +API Changes +--- + + +ABI Changes +--- + +* The ethdev rte_eth_link and rte_eth_conf structures were changed to + support the new link API, as well as ETH_LINK_HALF/FULL_DUPLEX. + +* The ethdev rte_eth_dev_info was changed to support device speed capabilities. + + +Shared Library Versions +--- + +The libraries prepended with a plus sign were incremented in this version. + +.. code-block:: diff + + libethdev.so.2 + librte_acl.so.2 + librte_cfgfile.so.2 + librte_cmdline.so.1 + librte_distributor.so.1 + librte_eal.so.2 + librte_hash.so.2 + librte_ip_frag.so.1 + librte_ivshmem.so.1 + librte_jobstats.so.1 + librte_kni.so.2 + librte_kvargs.so.1 + librte_lpm.so.2 + librte_mbuf.so.2 + librte_mempool.so.1 + librte_meter.so.1 + librte_pipeline.so.2 + librte_pmd_bond.so.1 + librte_pmd_ring.so.2 + librte_port.so.2 + librte_power.so.1 + librte_reorder.so.1 + librte_ring.so.1 + librte_sched.so.1 + librte_table.so.2 + librte_timer.so.1 + librte_vhost.so.2 -- 2.1.4
