[dpdk-dev] [PATCH] doc: add guideline for updating release notes

[dpdk-dev] [PATCH] doc: add guideline for updating release notes

[John McNamara]

>From version 2.2 of DPDK onwards patchsets should include
updates to the Release Notes for additions, fixes and
changes.

Add guideline on what to update in the Release Notes to the
Documentation Contribution guidelines.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
 doc/guides/contributing/documentation.rst | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst
index cb5ca0d..7c1eb41 100644
--- a/doc/guides/contributing/documentation.rst
+++ b/doc/guides/contributing/documentation.rst
@@ -63,9 +63,20 @@ added to by the developer.
   any known issues.
   The Releases Notes also contain notifications of features that will change ABI compatibility in the next major release.
 
-  Developers should update the Release Notes to add a short description of new or updated features.
-  Developers should also update the Release Notes to add ABI announcements if necessary,
-  (see :doc:`/contributing/versioning` for details).
+  Developers should include updates to the Release Notes with patch sets that relate to any of the following sections:
+
+  * New Features
+  * Resolved Issues (see below)
+  * Known Issues
+  * API Changes
+  * ABI Changes
+  * Shared Library Versions
+
+  Resolved Issues should only include issues from previous releases that have been resolved in the current release.
+  Issues that are introduced and then fixed within a release cycle do not have to be included here.
+
+  Refer to the Release Notes from the previous DPDK release for the correct format of each section.
+
 
 * **API documentation**
 
-- 
1.8.1.4

Re: [dpdk-dev] [PATCH] doc: add guideline for updating release notes

[Thomas Monjalon]

2015-09-11 12:04, John McNamara:
> From version 2.2 of DPDK onwards patchsets should include
> updates to the Release Notes for additions, fixes and
> changes.
> 
> Add guideline on what to update in the Release Notes to the
> Documentation Contribution guidelines.
> 
> Signed-off-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks.

It is now expected to be an acceptance criteria during reviews.

Any volunteer to fix the release notes for the previous commits?
	17e01e3 i40e: fix base driver allocation when not using first numa node
	45e73f4 ixgbe: remove burst size restriction of vector Rx
	b7fcd13 ixgbe: fix X550 DCB
	7d49e0f hash: fix memory allocation of cuckoo key table
	79db649 eal/linux: fix epoll timeout

Re: [dpdk-dev] [PATCH] doc: add guideline for updating release notes

[Mcnamara, John]

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Tuesday, September 15, 2015 10:13 AM
> To: Mcnamara, John
> Cc: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] doc: add guideline for updating release
> notes
> 
> 2015-09-11 12:04, John McNamara:
> > From version 2.2 of DPDK onwards patchsets should include updates to
> > the Release Notes for additions, fixes and changes.
> >
> > Add guideline on what to update in the Release Notes to the
> > Documentation Contribution guidelines.
> >
> > Signed-off-by: John McNamara <john.mcnamara@intel.com>
> 
> Applied, thanks.
> 
> It is now expected to be an acceptance criteria during reviews.
> 
> Any volunteer to fix the release notes for the previous commits?
> 	17e01e3 i40e: fix base driver allocation when not using first numa node
> 	45e73f4 ixgbe: remove burst size restriction of vector Rx
> 	b7fcd13 ixgbe: fix X550 DCB
> 	7d49e0f hash: fix memory allocation of cuckoo key table
> 	79db649 eal/linux: fix epoll timeout

Hi,

I'll fix the Release Notes based on the commit logs and CC the authors to ensure it is correct.

John