Skip to contentSkip to conversation

docs/system: clarify deprecation schedule

PATCH Applied Stefan Hajnoczi 3 participants 4 messages Sep 15, 2020 – Sep 23, 2020

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 docs/system: clarify deprecation schedule

The sentence explaining the deprecation schedule is ambiguous. Make it clear that a feature deprecated in the Nth release is guaranteed to remain available in the N+1th release. Removal can occur in the N+2nd release or later.

As an example of this in action, see commit 25956af3fe5dd0385ad8017bc768a6afe41e2a74 ("block: Finish deprecation of 'qemu-img convert -n -o'"). The feature was deprecated in QEMU 4.2.0. It was present in the 5.0.0 release and removed in the 5.1.0 release.

---
v2:
* Use Dan's suggested wording [Daniel Berrange]

---
 docs/system/deprecated.rst | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)
docs/system/deprecated.rst +5 -4
index 0cb8b01424..f2d5bd8ce1 100644
@@ -3,10 +3,11 @@ Deprecated features
 
 In general features are intended to be supported indefinitely once
 introduced into QEMU. In the event that a feature needs to be removed,
-it will be listed in this section. The feature will remain functional
-for 2 releases prior to actual removal. Deprecated features may also
-generate warnings on the console when QEMU starts up, or if activated
-via a monitor command, however, this is not a mandatory requirement.
+it will be listed in this section. The feature will remain functional for the
+release in which it was deprecated and one further release. After these two
+releases, the feature is liable to be removed. Deprecated features may also
+generate warnings on the console when QEMU starts up, or if activated via a
+monitor command, however, this is not a mandatory requirement.
 
 Prior to the 2.10.0 release there was no official policy on how
 long features would be deprecated prior to their removal, nor
Signature · 1 line
2.26.2
Reviewed-by on v2 1/1
#1 lore raw
Quoted 10 lines · Stefan Hajnoczi

The sentence explaining the deprecation schedule is ambiguous. Make it clear that a feature deprecated in the Nth release is guaranteed to remain available in the N+1th release. Removal can occur in the N+2nd release or later.

As an example of this in action, see commit 25956af3fe5dd0385ad8017bc768a6afe41e2a74 ("block: Finish deprecation of 'qemu-img convert -n -o'"). The feature was deprecated in QEMU 4.2.0. It was present in the 5.0.0 release and removed in the 5.1.0 release.

Quoted 8 lines

---
v2:
* Use Dan's suggested wording [Daniel Berrange]

---
 docs/system/deprecated.rst | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

Regards,
Daniel

Signature · 3 lines
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|
Reviewed-by on v2 1/1
#2 lore raw
In reply to Stefan Hajnoczi
Quoted 5 lines · Stefan Hajnoczi

The sentence explaining the deprecation schedule is ambiguous. Make it clear that a feature deprecated in the Nth release is guaranteed to remain available in the N+1th release. Removal can occur in the N+2nd release or later.

Quoted 7 lines

As an example of this in action, see commit 25956af3fe5dd0385ad8017bc768a6afe41e2a74 ("block: Finish deprecation of 'qemu-img convert -n -o'"). The feature was deprecated in QEMU 4.2.0. It was present in the 5.0.0 release and removed in the 5.1.0 release.

Quoted 28 lines

---
v2:
* Use Dan's suggested wording [Daniel Berrange]

---
 docs/system/deprecated.rst | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)
docs/system/deprecated.rst +5 -4
index 0cb8b01424..f2d5bd8ce1 100644
@@ -3,10 +3,11 @@ Deprecated features
 
 In general features are intended to be supported indefinitely once
 introduced into QEMU. In the event that a feature needs to be removed,
-it will be listed in this section. The feature will remain functional
-for 2 releases prior to actual removal. Deprecated features may also
-generate warnings on the console when QEMU starts up, or if activated
-via a monitor command, however, this is not a mandatory requirement.
+it will be listed in this section. The feature will remain functional for the
+release in which it was deprecated and one further release. After these two
+releases, the feature is liable to be removed. Deprecated features may also
+generate warnings on the console when QEMU starts up, or if activated via a
+monitor command, however, this is not a mandatory requirement.
 
 Prior to the 2.10.0 release there was no official policy on how
 long features would be deprecated prior to their removal, nor
author Applied
#3 lore raw
In reply to Stefan Hajnoczi
Quoted 10 lines · Stefan Hajnoczi

The sentence explaining the deprecation schedule is ambiguous. Make it clear that a feature deprecated in the Nth release is guaranteed to remain available in the N+1th release. Removal can occur in the N+2nd release or later.

As an example of this in action, see commit 25956af3fe5dd0385ad8017bc768a6afe41e2a74 ("block: Finish deprecation of 'qemu-img convert -n -o'"). The feature was deprecated in QEMU 4.2.0. It was present in the 5.0.0 release and removed in the 5.1.0 release.

Quoted 8 lines

---
v2:
* Use Dan's suggested wording [Daniel Berrange]

---
 docs/system/deprecated.rst | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

Thanks, applied to my block tree:
https://github.com/stefanha/qemu/commits/block

Stefan