Skip to contentSkip to conversation

doc: add note on hardware support deprecation

PATCH Superseded Bruce Richardson 3 participants 4 messages Sep 15, 2017 – Oct 13, 2017

lore
Share & tools
lore

Bruce Richardson

author
#0 lore raw

PATCH 1/1 doc: add note on hardware support deprecation

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 <[email protected]>
---
 doc/guides/contributing/versioning.rst | 9 +++++++++
 1 file changed, 9 insertions(+)
doc/guides/contributing/versioning.rst +9 -0
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
    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
 -------------------------------
Signature · 1 line
2.13.5
Acked-by on v1 1/1
#1 lore raw
Quoted 21 lines

-----Original Message-----
From: dev [mailto:[email protected]] On Behalf Of Bruce Richardson
Sent: Friday, September 15, 2017 2:41 PM
To: [email protected]
Cc: Richardson, Bruce <[email protected]>
Subject: [dpdk-dev] [PATCH] doc: add note on hardware support deprecation

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 <[email protected]>

...

+.. note::

Review

Quoted 2 lines
(quoted diff) +2 -0
+
+        Updates to the minimum HW requirements, which drop support for

s/HW/hardware

The next only needs to be indented 3 spaces to align with the directive.

Apart from that:

Acked-by John McNamara <[email protected]>
author
#2 lore raw

PATCH v2 1/1 doc: add note on hardware support deprecation

In reply to Bruce Richardson

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 <[email protected]>
Acked-by John McNamara <[email protected]>

---
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(+)
doc/guides/contributing/versioning.rst +9 -0
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
    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
 -------------------------------
Signature · 1 line
2.13.5