On 18 February 2016 at 19:14, Mcnamara, John <john.mcnamara at intel.com> 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 <wenzhuo.lu at intel.com>; Zhang, Helin > > <helin.zhang at intel.com>; Harish Patil <harish.patil at qlogic.com>; Chen, > > Jing D <jing.d.chen at intel.com> > > 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 <marcdevel at gmail.com> > > --- > > 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. > - > > > >