[virtio-comment] [PATCH 0/3] Fix missing verb and typos

[virtio-comment] [PATCH 0/3] Fix missing verb and typos

[Gaetan Harter]

Hi all,

this patchset fixes some missing verb and typos find while reading the spec.

It is a patchset but patches are indenendant.

Best regard,
Gaëtan

From: Gaetan Harter <gaetan.harter@opensynergy.com>
Reply-To:
Subject: [PATCH 0/3] Fix missing verb and typos
In-Reply-To:



Please mind our privacy notice<https://www.opensynergy.com/datenschutzerklaerung/privacy-notice-for-business-partners-pursuant-to-article-13-of-the-general-data-protection-regulation-gdpr/> pursuant to Art. 13 GDPR. // Unsere Hinweise zum Datenschutz gem. Art. 13 DSGVO finden Sie hier.<https://www.opensynergy.com/de/datenschutzerklaerung/datenschutzhinweise-fuer-geschaeftspartner-gem-art-13-dsgvo/>

This publicly archived list offers a means to provide input to the
OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and
to minimize spam in the list archive, subscription is required
before posting.

Subscribe: virtio-comment-subscribe@lists.oasis-open.org
Unsubscribe: virtio-comment-unsubscribe@lists.oasis-open.org
List help: virtio-comment-help@lists.oasis-open.org
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/

[virtio-comment] [PATCH 1/3] content: fix a typo

[Gaetan Harter]

Signed-off-by: Gaetan Harter <gaetan.harter@opensynergy.com>
---
 content.tex | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/content.tex b/content.tex
index ceb2562..31b02e1 100644
--- a/content.tex
+++ b/content.tex
@@ -4338,7 +4338,7 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Network Device / Devi

 There is a corresponding device feature for each offload. Upon feature
 negotiation corresponding offload gets enabled to preserve backward
-compartibility.
+compatibility.

 \drivernormative{\subparagraph}{Setting Offloads State}{Device Types / Network Device / Device Operation / Control Virtqueue / Offloads State Configuration / Setting Offloads State}

--
2.25.1


Please mind our privacy notice<https://www.opensynergy.com/datenschutzerklaerung/privacy-notice-for-business-partners-pursuant-to-article-13-of-the-general-data-protection-regulation-gdpr/> pursuant to Art. 13 GDPR. // Unsere Hinweise zum Datenschutz gem. Art. 13 DSGVO finden Sie hier.<https://www.opensynergy.com/de/datenschutzerklaerung/datenschutzhinweise-fuer-geschaeftspartner-gem-art-13-dsgvo/>

This publicly archived list offers a means to provide input to the
OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and
to minimize spam in the list archive, subscription is required
before posting.

Subscribe: virtio-comment-subscribe@lists.oasis-open.org
Unsubscribe: virtio-comment-unsubscribe@lists.oasis-open.org
List help: virtio-comment-help@lists.oasis-open.org
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/

[virtio-comment] [PATCH 2/3] virtio-gpu: fix a typo

[Gaetan Harter]

Signed-off-by: Gaetan Harter <gaetan.harter@opensynergy.com>
---
 virtio-gpu.tex | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/virtio-gpu.tex b/virtio-gpu.tex
index a6afeda..7bfb8dd 100644
--- a/virtio-gpu.tex
+++ b/virtio-gpu.tex
@@ -27,7 +27,7 @@ \subsection{Virtqueues}\label{sec:Device Types / GPU Device / Virtqueues}
 a fixed header, followed by command specific data fields.  The
 separate cursor queue is the "fast track" for cursor commands
 (VIRTIO_GPU_CMD_UPDATE_CURSOR and VIRTIO_GPU_CMD_MOVE_CURSOR), so they
-go though without being delayed by time-consuming commands in the
+go through without being delayed by time-consuming commands in the
 control queue.

 \subsection{Feature bits}\label{sec:Device Types / GPU Device / Feature bits}
--
2.25.1


Please mind our privacy notice<https://www.opensynergy.com/datenschutzerklaerung/privacy-notice-for-business-partners-pursuant-to-article-13-of-the-general-data-protection-regulation-gdpr/> pursuant to Art. 13 GDPR. // Unsere Hinweise zum Datenschutz gem. Art. 13 DSGVO finden Sie hier.<https://www.opensynergy.com/de/datenschutzerklaerung/datenschutzhinweise-fuer-geschaeftspartner-gem-art-13-dsgvo/>

This publicly archived list offers a means to provide input to the
OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and
to minimize spam in the list archive, subscription is required
before posting.

Subscribe: virtio-comment-subscribe@lists.oasis-open.org
Unsubscribe: virtio-comment-unsubscribe@lists.oasis-open.org
List help: virtio-comment-help@lists.oasis-open.org
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/

[virtio-comment] [PATCH 3/3] virtio-crypto: fix missing verb

[Gaetan Harter]

The condition was incomplete "guarantee the size IS within the max_len".

Signed-off-by: Gaetan Harter <gaetan.harter@opensynergy.com>
---
 virtio-crypto.tex | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/virtio-crypto.tex b/virtio-crypto.tex
index 4a15e14..0d1d832 100644
--- a/virtio-crypto.tex
+++ b/virtio-crypto.tex
@@ -275,13 +275,13 @@ \subsection{Device configuration layout}\label{sec:Device Types / Crypto Device
 \item The driver MUST read the detailed algorithms fields based on \field{crypto_services} field.
 \item The driver SHOULD read \field{max_size} to discover the maximum size of the variable-length
     parameters of data operation of the crypto request's content the device supports and MUST
-    guarantee the size of each crypto request's content within the \field{max_size}, otherwise
+    guarantee the size of each crypto request's content is within the \field{max_size}, otherwise
     the request will fail and the driver MUST reset the device.
 \item The driver SHOULD read \field{max_cipher_key_len} to discover the maximum length of cipher key
-    the device supports and MUST guarantee the \field{key_len} (CIPHER service or AEAD service) within
+    the device supports and MUST guarantee the \field{key_len} (CIPHER service or AEAD service) is within
     the \field{max_cipher_key_len} of the device configuration, otherwise the request will fail.
 \item The driver SHOULD read \field{max_auth_key_len} to discover the maximum length of authenticated
-    key the device supports and MUST guarantee the \field{auth_key_len} (MAC service) within the
+    key the device supports and MUST guarantee the \field{auth_key_len} (MAC service) is within the
     \field{max_auth_key_len} of the device configuration, otherwise the request will fail.
 \end{itemize*}

--
2.25.1


Please mind our privacy notice<https://www.opensynergy.com/datenschutzerklaerung/privacy-notice-for-business-partners-pursuant-to-article-13-of-the-general-data-protection-regulation-gdpr/> pursuant to Art. 13 GDPR. // Unsere Hinweise zum Datenschutz gem. Art. 13 DSGVO finden Sie hier.<https://www.opensynergy.com/de/datenschutzerklaerung/datenschutzhinweise-fuer-geschaeftspartner-gem-art-13-dsgvo/>

This publicly archived list offers a means to provide input to the
OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and
to minimize spam in the list archive, subscription is required
before posting.

Subscribe: virtio-comment-subscribe@lists.oasis-open.org
Unsubscribe: virtio-comment-unsubscribe@lists.oasis-open.org
List help: virtio-comment-help@lists.oasis-open.org
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/

Re: [virtio-comment] [PATCH 0/3] Fix missing verb and typos

[Stefan Hajnoczi]

[-- Attachment #1: Type: text/plain, Size: 337 bytes --]

On Mon, Jul 26, 2021 at 06:38:47PM +0200, Gaetan Harter wrote:
> Hi all,
> 
> this patchset fixes some missing verb and typos find while reading the spec.
> 
> It is a patchset but patches are indenendant.

Thanks, Gaëtan! I think these patches can be merged without a vote.

Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: [virtio-comment] [PATCH 3/3] virtio-crypto: fix missing verb

[Cornelia Huck]

On Mon, Jul 26 2021, Gaetan Harter <gaetan.harter@opensynergy.com> wrote:

> The condition was incomplete "guarantee the size IS within the max_len".
>
> Signed-off-by: Gaetan Harter <gaetan.harter@opensynergy.com>
> ---
>  virtio-crypto.tex | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/virtio-crypto.tex b/virtio-crypto.tex
> index 4a15e14..0d1d832 100644
> --- a/virtio-crypto.tex
> +++ b/virtio-crypto.tex
> @@ -275,13 +275,13 @@ \subsection{Device configuration layout}\label{sec:Device Types / Crypto Device
>  \item The driver MUST read the detailed algorithms fields based on \field{crypto_services} field.
>  \item The driver SHOULD read \field{max_size} to discover the maximum size of the variable-length
>      parameters of data operation of the crypto request's content the device supports and MUST
> -    guarantee the size of each crypto request's content within the \field{max_size}, otherwise
> +    guarantee the size of each crypto request's content is within the \field{max_size}, otherwise
>      the request will fail and the driver MUST reset the device.
>  \item The driver SHOULD read \field{max_cipher_key_len} to discover the maximum length of cipher key
> -    the device supports and MUST guarantee the \field{key_len} (CIPHER service or AEAD service) within
> +    the device supports and MUST guarantee the \field{key_len} (CIPHER service or AEAD service) is within
>      the \field{max_cipher_key_len} of the device configuration, otherwise the request will fail.
>  \item The driver SHOULD read \field{max_auth_key_len} to discover the maximum length of authenticated
> -    key the device supports and MUST guarantee the \field{auth_key_len} (MAC service) within the
> +    key the device supports and MUST guarantee the \field{auth_key_len} (MAC service) is within the
>      \field{max_auth_key_len} of the device configuration, otherwise the request will fail.
>  \end{itemize*}

This still seems a bit awkward. I'd make that either "MUST guarantee
(...) to be within (...)", or "MUST guarantee that (...) is within
(...)". What do you think?


This publicly archived list offers a means to provide input to the
OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and
to minimize spam in the list archive, subscription is required
before posting.

Subscribe: virtio-comment-subscribe@lists.oasis-open.org
Unsubscribe: virtio-comment-unsubscribe@lists.oasis-open.org
List help: virtio-comment-help@lists.oasis-open.org
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/

Re: [virtio-comment] [PATCH 0/3] Fix missing verb and typos

[Cornelia Huck]

On Mon, Jul 26 2021, Gaetan Harter <gaetan.harter@opensynergy.com> wrote:

> Hi all,
>
> this patchset fixes some missing verb and typos find while reading the spec.
>
> It is a patchset but patches are indenendant.
>
> Best regard,
> Gaëtan
>

Thanks, pushed patches 1-2 as editorial update.


This publicly archived list offers a means to provide input to the
OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and
to minimize spam in the list archive, subscription is required
before posting.

Subscribe: virtio-comment-subscribe@lists.oasis-open.org
Unsubscribe: virtio-comment-unsubscribe@lists.oasis-open.org
List help: virtio-comment-help@lists.oasis-open.org
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/

Re: [virtio-comment] [PATCH 3/3] virtio-crypto: fix missing verb

[Gaëtan Harter]

On 27.07.21 15:49, Cornelia Huck wrote

> On Mon, Jul 26 2021, Gaetan Harter <gaetan.harter@opensynergy.com> wrote:
>> The condition was incomplete "guarantee the size IS within the max_len".
>>
>> Signed-off-by: Gaetan Harter <gaetan.harter@opensynergy.com>
>> ---
>>   virtio-crypto.tex | 6 +++---
>>   1 file changed, 3 insertions(+), 3 deletions(-)
>>
>> diff --git a/virtio-crypto.tex b/virtio-crypto.tex
>> index 4a15e14..0d1d832 100644
>> --- a/virtio-crypto.tex
>> +++ b/virtio-crypto.tex
>> @@ -275,13 +275,13 @@ \subsection{Device configuration layout}\label{sec:Device Types / Crypto Device
>>   \item The driver MUST read the detailed algorithms fields based on \field{crypto_services} field.
>>   \item The driver SHOULD read \field{max_size} to discover the maximum size of the variable-length
>>       parameters of data operation of the crypto request's content the device supports and MUST
>> -    guarantee the size of each crypto request's content within the \field{max_size}, otherwise
>> +    guarantee the size of each crypto request's content is within the \field{max_size}, otherwise
>>       the request will fail and the driver MUST reset the device.
>>   \item The driver SHOULD read \field{max_cipher_key_len} to discover the maximum length of cipher key
>> -    the device supports and MUST guarantee the \field{key_len} (CIPHER service or AEAD service) within
>> +    the device supports and MUST guarantee the \field{key_len} (CIPHER service or AEAD service) is within
>>       the \field{max_cipher_key_len} of the device configuration, otherwise the request will fail.
>>   \item The driver SHOULD read \field{max_auth_key_len} to discover the maximum length of authenticated
>> -    key the device supports and MUST guarantee the \field{auth_key_len} (MAC service) within the
>> +    key the device supports and MUST guarantee the \field{auth_key_len} (MAC service) is within the
>>       \field{max_auth_key_len} of the device configuration, otherwise the request will fail.
>>   \end{itemize*}
> This still seems a bit awkward. I'd make that either "MUST guarantee
> (...) to be within (...)", or "MUST guarantee that (...) is within
> (...)". What do you think?
> auie

I agree

 From a non native English speaker, I think I prefer your second version based on
the current text.  I read the sentence as an active process "read to discover,
and guarantee, otherwise the request will fail" and it is easier for me.
Where I feel the first one, with "to be" to be more a static.

I will send an updated version.

Thank you.

Best regards

--
Gaëtan


Please mind our privacy notice<https://www.opensynergy.com/datenschutzerklaerung/privacy-notice-for-business-partners-pursuant-to-article-13-of-the-general-data-protection-regulation-gdpr/> pursuant to Art. 13 GDPR. // Unsere Hinweise zum Datenschutz gem. Art. 13 DSGVO finden Sie hier.<https://www.opensynergy.com/de/datenschutzerklaerung/datenschutzhinweise-fuer-geschaeftspartner-gem-art-13-dsgvo/>