Skip to contentSkip to conversation

conformance: fix confusion about legacy interface

PATCH In review Michael S. Tsirkin 3 participants 3 messages Mar 14, 2019 – Mar 15, 2019

lore
Share & tools
lore
#0 lore raw

PATCH v5 1/1 conformance: fix confusion about legacy interface

Supercedes:
"conformance: clarify transitional/non-transitional"

The text describing the legacy interface also obliquely refers to a non-transitional implementation. This seems to cause confusion and there's no good reason to do it here: this section is about legacy interface and transitional devices,
it add not value at all. Just drop it. We need to tweak wording in the next paragraph to avoid saying "additionally" since there's nothing to add to anymore.

Note: the spec does not make it clear whether description of the legacy interface is normative or not, and in particular, this section is not linked to from any conformance targets.
Resolving that is left for after 1.1 since the text is not new and was already there in 1.0.

VIRTIO-167

---
 conformance.tex | 6 +-----
 1 file changed, 1 insertion(+), 5 deletions(-)
conformance.tex +1 -5
index 6df113b..ce51463 100644
@@ -341,13 +341,9 @@ A conformant implementation MUST be either transitional or
 non-transitional, see \ref{intro:Legacy
 Interface: Terminology}.
 
-A non-transitional implementation conforms to this specification
-if it satisfies all of the MUST or REQUIRED level requirements
-defined above.
-
 An implementation MAY choose to implement OPTIONAL support for the
 legacy interface, including support for legacy drivers
-or devices, by additionally conforming to all of the MUST or
+or devices, by conforming to all of the MUST or
 REQUIRED level requirements for the legacy interface
 for the transitional devices and drivers.
 
Signature · 6 lines
MST

---------------------------------------------------------------------
To unsubscribe from this mail list, you must leave the OASIS TC that 
generates this mail.  Follow this link to all your TCs in OASIS at:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php 
Reviewed-by on v5 1/1
#1 lore raw
Quoted 33 lines · On Thu, 14 Mar 2019 14:44:02 -0400 "Michael S. Tsirkin" <[email protected]> wrote:

Supercedes:
"conformance: clarify transitional/non-transitional"

The text describing the legacy interface also obliquely refers to a non-transitional implementation. This seems to cause confusion and there's no good reason to do it here: this section is about legacy interface and transitional devices,
it add not value at all. Just drop it. We need to tweak wording in the next paragraph to avoid saying "additionally" since there's nothing to add to anymore.

Note: the spec does not make it clear whether description of the legacy interface is normative or not, and in particular, this section is not linked to from any conformance targets.
Resolving that is left for after 1.1 since the text is not new and was already there in 1.0.

VIRTIO-167

---
 conformance.tex | 6 +-----
 1 file changed, 1 insertion(+), 5 deletions(-)
conformance.tex +0 -1
index 6df113b..ce51463 100644
@@ -341,13 +341,9 @@ A conformant implementation MUST be either transitional or
 non-transitional, see \ref{intro:Legacy
 Interface: Terminology}.
 
-A non-transitional implementation conforms to this specification

conformance.tex A conformant implementation MUST be either transitional or · line 349

Quoted 10 lines
conformance.tex +1 -4
-if it satisfies all of the MUST or REQUIRED level requirements
-defined above.
-
 An implementation MAY choose to implement OPTIONAL support for the
 legacy interface, including support for legacy drivers
-or devices, by additionally conforming to all of the MUST or
+or devices, by conforming to all of the MUST or
 REQUIRED level requirements for the legacy interface
 for the transitional devices and drivers.
 

It's probably best we can do right now if we don't want to do more invasive changes... fine with me as well.

---------------------------------------------------------------------
To unsubscribe from this mail list, you must leave the OASIS TC that generates this mail. Follow this link to all your TCs in OASIS at:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php

Acked-by on v5 1/1
#2 lore raw
In reply to Michael S. Tsirkin
Quoted 2 lines · On Thu, 14 Mar 2019 14:44:02 -0400 "Michael S. Tsirkin" <[email protected]> wrote:

Supercedes:
"conformance: clarify transitional/non-transitional"

I don't think this is ought to be a part of the commit message.

Quoted 9 lines

The text describing the legacy interface also obliquely refers to a non-transitional implementation. This seems to cause confusion and there's no good reason to do it here: this section is about legacy interface and transitional devices,
it add not value at all. Just drop it. We need to tweak wording in the next paragraph to avoid saying "additionally" since there's nothing to add to anymore.

Quoted 5 lines

Note: the spec does not make it clear whether description of the legacy interface is normative or not, and in particular, this section is not linked to from any conformance targets.
Resolving that is left for after 1.1 since the text is not new and was already there in 1.0.

Sounds good.

Quoted 17 lines

VIRTIO-167

---
 conformance.tex | 6 +-----
 1 file changed, 1 insertion(+), 5 deletions(-)
conformance.tex +0 -1
index 6df113b..ce51463 100644
@@ -341,13 +341,9 @@ A conformant implementation MUST be either transitional or
 non-transitional, see \ref{intro:Legacy
 Interface: Terminology}.
 
-A non-transitional implementation conforms to this specification

conformance.tex A conformant implementation MUST be either transitional or · line 349

Quoted 10 lines
conformance.tex +1 -4
-if it satisfies all of the MUST or REQUIRED level requirements
-defined above.
-
 An implementation MAY choose to implement OPTIONAL support for the
 legacy interface, including support for legacy drivers
-or devices, by additionally conforming to all of the MUST or
+or devices, by conforming to all of the MUST or
 REQUIRED level requirements for the legacy interface
 for the transitional devices and drivers.
 

I pointed out some issues with the resulting text, but these are remaining issues and not issues introduced by this change.

I'm quite happy with this change. With the commit message tweak:

---------------------------------------------------------------------
To unsubscribe from this mail list, you must leave the OASIS TC that generates this mail. Follow this link to all your TCs in OASIS at:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php