[dpdk-dev] [PATCH] doc: add note on hardware support deprecation

Bruce Richardson bruce.richardson at intel.com
Fri Sep 15 15:41:14 CEST 2017


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 <bruce.richardson at intel.com>
---
 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
 -------------------------------
 
-- 
2.13.5



More information about the dev mailing list