From patchwork Fri Sep 15 13:41:14 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruce Richardson X-Patchwork-Id: 28760 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 7DF6E2BBE; Fri, 15 Sep 2017 15:41:24 +0200 (CEST) Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by dpdk.org (Postfix) with ESMTP id 8FAF125E5 for ; Fri, 15 Sep 2017 15:41:23 +0200 (CEST) Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga104.jf.intel.com with ESMTP; 15 Sep 2017 06:41:22 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.42,397,1500966000"; d="scan'208";a="135733560" Received: from silpixa00399126.ir.intel.com (HELO silpixa00399126.ger.corp.intel.com) ([10.237.223.223]) by orsmga002.jf.intel.com with ESMTP; 15 Sep 2017 06:41:21 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson Date: Fri, 15 Sep 2017 14:41:14 +0100 Message-Id: <20170915134114.127774-1-bruce.richardson@intel.com> X-Mailer: git-send-email 2.13.5 Subject: [dpdk-dev] [PATCH] 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: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 --- 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 HW 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 HW 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 -------------------------------