[dpdk-dev] [PATCH v2] doc: add note on hardware support deprecation
bruce.richardson at intel.com
Mon Sep 18 15:59:55 CEST 2017
Following agreement at the DPDK Technical Board meeting , the policy
that hardware support deprecation should be treated as though it were an
ABI break needs to be documented in the contributors guide.
Signed-off-by: Bruce Richardson <bruce.richardson at intel.com>
Acked-by: John McNamara <john.mcnamara at intel.com>
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
@@ -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
+#. 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.
+ 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
More information about the dev