From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id 3B76825A1 for ; Mon, 18 Sep 2017 16:00:34 +0200 (CEST) Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga102.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 18 Sep 2017 07:00:32 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.42,413,1500966000"; d="scan'208";a="1220317485" Received: from silpixa00399126.ir.intel.com (HELO silpixa00399126.ger.corp.intel.com) ([10.237.223.223]) by fmsmga002.fm.intel.com with ESMTP; 18 Sep 2017 07:00:31 -0700 From: Bruce Richardson To: john.mcnamara@intel.com, dev@dpdk.org Cc: Bruce Richardson Date: Mon, 18 Sep 2017 14:59:55 +0100 Message-Id: <20170918135955.36613-1-bruce.richardson@intel.com> X-Mailer: git-send-email 2.13.5 In-Reply-To: <20170915134114.127774-1-bruce.richardson@intel.com> References: <20170915134114.127774-1-bruce.richardson@intel.com> Subject: [dpdk-dev] [PATCH v2] doc: add note on hardware support deprecation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 18 Sep 2017 14:00:34 -0000 Following agreement at the DPDK Technical Board meeting [1], the policy that hardware support deprecation should be treated as though it were an ABI break needs to be documented in the contributors guide. [1] http://dpdk.org/ml/archives/dev/2017-September/074613.html Signed-off-by: Bruce Richardson Acked-by: John McNamara --- V2: change HW abbreviation to "hardware" and reduce indentation of note to 3 spaces only. doc/guides/contributing/versioning.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst index 8aaf370da..2ec561647 100644 --- a/doc/guides/contributing/versioning.rst +++ b/doc/guides/contributing/versioning.rst @@ -18,6 +18,8 @@ General Guidelines #. The modification of symbols can generally be managed with versioning #. The removal of symbols generally is an ABI break and requires bumping of the LIBABIVER macro +#. Updates to the minimum hardware requirements, which drop support for hardware which + was previously supported, should be treated as an ABI change. What is an ABI -------------- @@ -77,6 +79,13 @@ for significant reasons, such as performance enhancements. ABI breakage due to changes such as reorganizing public structure fields for aesthetic or readability purposes should be avoided. +.. note:: + + Updates to the minimum hardware requirements, which drop support for hardware + which was previously supported, should be treated as an ABI change, and + follow the relevant deprecation policy procedures as above: 3 acks and + announcement at least one release in advance. + Examples of Deprecation Notices ------------------------------- -- 2.13.5