>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 at 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
