From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id 607FE2A07 for ; Fri, 11 Sep 2015 13:04:31 +0200 (CEST) Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga102.fm.intel.com with ESMTP; 11 Sep 2015 04:04:30 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.17,511,1437462000"; d="scan'208,223";a="802361383" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by orsmga002.jf.intel.com with ESMTP; 11 Sep 2015 04:04:29 -0700 Received: from sivswdev02.ir.intel.com (sivswdev02.ir.intel.com [10.237.217.46]) by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id t8BB4SjM012527; Fri, 11 Sep 2015 12:04:28 +0100 Received: from sivswdev02.ir.intel.com (localhost [127.0.0.1]) by sivswdev02.ir.intel.com with ESMTP id t8BB4Ss2003489; Fri, 11 Sep 2015 12:04:28 +0100 Received: (from jmcnam2x@localhost) by sivswdev02.ir.intel.com with id t8BB4SVN003485; Fri, 11 Sep 2015 12:04:28 +0100 From: John McNamara To: dev@dpdk.org Date: Fri, 11 Sep 2015 12:04:28 +0100 Message-Id: <1441969468-3454-1-git-send-email-john.mcnamara@intel.com> X-Mailer: git-send-email 1.7.4.1 Subject: [dpdk-dev] [PATCH] doc: add guideline for updating release notes X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 11 Sep 2015 11:04:31 -0000 >>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 --- 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