Re: [dpdk-dev] [PATCH v1] doc: update release notes for 17.02

["Mcnamara, John" <john.mcnamara@intel.com>]

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Tuesday, February 14, 2017 3:51 PM
> To: Mcnamara, John <john.mcnamara@intel.com>
> Cc: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH v1] doc: update release notes for 17.02
> 
> 2017-02-14 15:32, John McNamara:
> > -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.
> > -     The title should contain the code/lib section like a commit
> message.
> > -     Add the entries in alphabetic order in the relevant sections
> below.
> > -
> > -   This section is a comment. do not overwrite or remove it.
> > -   Also, make sure to start the actual text at the margin.
> > -   =========================================================
> > -
> > -
> > -EAL
> > -~~~
> > -
> >
> >  Drivers
> >  ~~~~~~~
> >
> >  * **net/virtio: Fixed multiple process support.**
> >
> > -  Fixed few regressions introduced in recent releases that break the
> > virtio
> > +  Fixed a few regressions introduced in recent releases that break
> > + the virtio
> >    multiple process support.
> >
> >
> > -Libraries
> > -~~~~~~~~~
> > -
> > -
> >  Examples
> >  ~~~~~~~~
> >
> >  * **examples/ethtool: Fixed crash with non-PCI devices.**
> >
> > -  Querying a non-PCI device was dereferencing non-existent PCI data
> > -  resulting in a segmentation fault.
> > +  Fixed issue where querying a non-PCI device was dereferencing
> > + non-existent  PCI data resulting in a segmentation fault.
> 
> It looks strange to remove the "Resolved Issues" heading while keeping
> content.
> I think we could totally remove them as most of the fixes are not
> documented here anyway.

You are right. That was a mistake on my side, I meant to leave the heading.

However, now that you mention it, it doesn't look good that we have a
"Resolved Issues" section with just 2 fixes. I don't think they capture
the range of fixes in this release. Maybe we need to be more disciplined
with including information in the Release Notes when non-trivial fixes are
submitted.

In this case I'll put back in the "Resolved Issues" heading and submit a v2.

John