[PATCH 0/3] editorial: Fix spelling errors

[PATCH 0/3] editorial: Fix spelling errors

[Parav Pandit]

Fix spelling errors in gpu device, crypto device and in
common portion of the specification.

Parav Pandit (3):
  crypto: editorial: Fix spelling errors
  gpu: editorial: Fix spelling errors
  common: editorial: Fix spelling errors

 admin.tex                           |  2 +-
 content.tex                         |  4 ++--
 device-types/crypto/description.tex | 10 +++++-----
 device-types/gpu/description.tex    |  4 ++--
 4 files changed, 10 insertions(+), 10 deletions(-)

-- 
2.34.1

[PATCH 1/3] crypto: editorial: Fix spelling errors

[Parav Pandit]

Fix spelling errors.

Branch: virtio-1.4
Fixes: a385dd3366a2 ("virtio-crypto: Add virtio crypto device specification")
Signed-off-by: Parav Pandit <parav@nvidia.com>
---
 device-types/crypto/description.tex | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/device-types/crypto/description.tex b/device-types/crypto/description.tex
index 5705e26..e053cc7 100644
--- a/device-types/crypto/description.tex
+++ b/device-types/crypto/description.tex
@@ -424,11 +424,11 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Crypto Device / Devic
 
 \field{header} is a general header (see above).
 
-\field{op_flf} is the opcode (in \field{header}) specific fixed-length paramenters.
+\field{op_flf} is the opcode (in \field{header}) specific fixed-length parameters.
 
 \field{flf_len} depends on the VIRTIO_CRYPTO_F_REVISION_1 feature bit (see below).
 
-\field{op_vlf} is the opcode (in \field{header}) specific variable-length paramenters.
+\field{op_vlf} is the opcode (in \field{header}) specific variable-length parameters.
 
 \field{vlf_len} is the size of the specific structure used.
 \begin{note}
@@ -509,7 +509,7 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Crypto Device / Devic
 \subparagraph{Session operation: HASH session}\label{sec:Device Types / Crypto Device / Device
 Operation / Control Virtqueue / Session operation / Session operation: HASH session}
 
-The fixed-length paramenters of HASH session requests is as follows:
+The fixed-length parameters of HASH session requests is as follows:
 
 \begin{lstlisting}
 struct virtio_crypto_hash_create_session_flf {
@@ -1386,7 +1386,7 @@ \subsubsection{Symmetric algorithms Operation}\label{sec:Device Types / Crypto D
 \end{itemize*}
 
 The length of \field{op_type_flf} is fixed to 40 bytes, the data of unused
-part (if has) will be ingored.
+part (if has) will be ignored.
 
 \field{op_type_vlf} is the \field{op_type} specific parameters, it MUST starts
 with or be one of the following structures:
@@ -1536,7 +1536,7 @@ \subsubsection{Symmetric algorithms Operation}\label{sec:Device Types / Crypto D
 \end{itemize*}
 
 The length of \field{op_type_flf} is fixed to 72 bytes, the data of unused
-part (if has) will be ingored.
+part (if has) will be ignored.
 
 \field{op_type_vlf} is the \field{op_type} specific parameters, it MUST starts
 with or be one of the following structures:
-- 
2.34.1

Re: [PATCH 1/3] crypto: editorial: Fix spelling errors

[Matias Ezequiel Vara Larsen]

On Sat, Sep 07, 2024 at 08:48:17PM +0300, Parav Pandit wrote:
> Fix spelling errors.
> 
> Branch: virtio-1.4
> Fixes: a385dd3366a2 ("virtio-crypto: Add virtio crypto device specification")
> Signed-off-by: Parav Pandit <parav@nvidia.com>
> ---
>  device-types/crypto/description.tex | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/device-types/crypto/description.tex b/device-types/crypto/description.tex
> index 5705e26..e053cc7 100644
> --- a/device-types/crypto/description.tex
> +++ b/device-types/crypto/description.tex
> @@ -424,11 +424,11 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Crypto Device / Devic
>  
>  \field{header} is a general header (see above).
>  
> -\field{op_flf} is the opcode (in \field{header}) specific fixed-length paramenters.
> +\field{op_flf} is the opcode (in \field{header}) specific fixed-length parameters.
>  
>  \field{flf_len} depends on the VIRTIO_CRYPTO_F_REVISION_1 feature bit (see below).
>  
> -\field{op_vlf} is the opcode (in \field{header}) specific variable-length paramenters.
> +\field{op_vlf} is the opcode (in \field{header}) specific variable-length parameters.
>  
>  \field{vlf_len} is the size of the specific structure used.
>  \begin{note}
> @@ -509,7 +509,7 @@ \subsubsection{Control Virtqueue}\label{sec:Device Types / Crypto Device / Devic
>  \subparagraph{Session operation: HASH session}\label{sec:Device Types / Crypto Device / Device
>  Operation / Control Virtqueue / Session operation / Session operation: HASH session}
>  
> -The fixed-length paramenters of HASH session requests is as follows:
> +The fixed-length parameters of HASH session requests is as follows:
>  
>  \begin{lstlisting}
>  struct virtio_crypto_hash_create_session_flf {
> @@ -1386,7 +1386,7 @@ \subsubsection{Symmetric algorithms Operation}\label{sec:Device Types / Crypto D
>  \end{itemize*}
>  
>  The length of \field{op_type_flf} is fixed to 40 bytes, the data of unused
> -part (if has) will be ingored.
> +part (if has) will be ignored.
>  
>  \field{op_type_vlf} is the \field{op_type} specific parameters, it MUST starts
>  with or be one of the following structures:
> @@ -1536,7 +1536,7 @@ \subsubsection{Symmetric algorithms Operation}\label{sec:Device Types / Crypto D
>  \end{itemize*}
>  
>  The length of \field{op_type_flf} is fixed to 72 bytes, the data of unused
> -part (if has) will be ingored.
> +part (if has) will be ignored.
>  
>  \field{op_type_vlf} is the \field{op_type} specific parameters, it MUST starts
>  with or be one of the following structures:
> -- 
> 2.34.1
> 
> 

Reviewed-by: Matias Ezequiel Vara Larsen <mvaralar@redhat.com>

Thanks.

[PATCH 2/3] gpu: editorial: Fix spelling errors

[Parav Pandit]

Fix spelling errors.

Branch: virtio-1.4
Fixes: fed64230bf31 ("Add virtio gpu device specification.")
Signed-off-by: Parav Pandit <parav@nvidia.com>
---
 device-types/gpu/description.tex | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/device-types/gpu/description.tex b/device-types/gpu/description.tex
index 66e4873..ba4ea76 100644
--- a/device-types/gpu/description.tex
+++ b/device-types/gpu/description.tex
@@ -166,7 +166,7 @@ \subsubsection{Device Operation: Multihead setup}
 
 \devicenormative{\subsubsection}{Device Operation: Command lifecycle and fencing}{Device Types / GPU Device / Device Operation / Device Operation: Command lifecycle and fencing}
 
-The device MAY process controlq commands asyncronously and return them
+The device MAY process controlq commands asynchronously and return them
 to the driver before the processing is complete.  If the driver needs
 to know when the processing is finished it can set the
 VIRTIO_GPU_FLAG_FENCE flag in the request.  The device MUST finish the
@@ -345,7 +345,7 @@ \subsubsection{Device Operation: controlq}\label{sec:Device Types / GPU Device /
 display).
 
 The \field{enabled} field is set when the user enabled the display.
-It is roughly the same as the connected state of a phyiscal display
+It is roughly the same as the connected state of a physical display
 connector.
 
 \item[VIRTIO_GPU_CMD_GET_EDID] Retrieve the EDID data for a given
-- 
2.34.1

Re: [PATCH 2/3] gpu: editorial: Fix spelling errors

[Matias Ezequiel Vara Larsen]

On Sat, Sep 07, 2024 at 08:48:18PM +0300, Parav Pandit wrote:
> Fix spelling errors.
> 
> Branch: virtio-1.4
> Fixes: fed64230bf31 ("Add virtio gpu device specification.")
> Signed-off-by: Parav Pandit <parav@nvidia.com>
> ---
>  device-types/gpu/description.tex | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/device-types/gpu/description.tex b/device-types/gpu/description.tex
> index 66e4873..ba4ea76 100644
> --- a/device-types/gpu/description.tex
> +++ b/device-types/gpu/description.tex
> @@ -166,7 +166,7 @@ \subsubsection{Device Operation: Multihead setup}
>  
>  \devicenormative{\subsubsection}{Device Operation: Command lifecycle and fencing}{Device Types / GPU Device / Device Operation / Device Operation: Command lifecycle and fencing}
>  
> -The device MAY process controlq commands asyncronously and return them
> +The device MAY process controlq commands asynchronously and return them
>  to the driver before the processing is complete.  If the driver needs

I think here is `completed` instead of `complete` although it is not
part of this patch.

>  to know when the processing is finished it can set the
>  VIRTIO_GPU_FLAG_FENCE flag in the request.  The device MUST finish the
> @@ -345,7 +345,7 @@ \subsubsection{Device Operation: controlq}\label{sec:Device Types / GPU Device /
>  display).
>  
>  The \field{enabled} field is set when the user enabled the display.

I am not sure if it is `enables` instead of `enabled`.

> -It is roughly the same as the connected state of a phyiscal display
> +It is roughly the same as the connected state of a physical display
>  connector.
>  
>  \item[VIRTIO_GPU_CMD_GET_EDID] Retrieve the EDID data for a given
> -- 
> 2.34.1
> 
> 

Reviewed-by: Matias Ezequiel Vara Larsen <mvaralar@redhat.com>

Thanks, Matias.

RE: [PATCH 2/3] gpu: editorial: Fix spelling errors

[Parav Pandit]

> From: Matias Ezequiel Vara Larsen <mvaralar@redhat.com>
> Sent: Monday, September 9, 2024 7:42 PM
> 
> On Sat, Sep 07, 2024 at 08:48:18PM +0300, Parav Pandit wrote:
> > Fix spelling errors.
> >
> > Branch: virtio-1.4
> > Fixes: fed64230bf31 ("Add virtio gpu device specification.")
> > Signed-off-by: Parav Pandit <parav@nvidia.com>
> > ---
> >  device-types/gpu/description.tex | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/device-types/gpu/description.tex
> > b/device-types/gpu/description.tex
> > index 66e4873..ba4ea76 100644
> > --- a/device-types/gpu/description.tex
> > +++ b/device-types/gpu/description.tex
> > @@ -166,7 +166,7 @@ \subsubsection{Device Operation: Multihead setup}
> >
> >  \devicenormative{\subsubsection}{Device Operation: Command lifecycle
> > and fencing}{Device Types / GPU Device / Device Operation / Device
> > Operation: Command lifecycle and fencing}
> >
> > -The device MAY process controlq commands asyncronously and return
> > them
> > +The device MAY process controlq commands asynchronously and return
> > +them
> >  to the driver before the processing is complete.  If the driver needs
> 
> I think here is `completed` instead of `complete` although it is not part of
> this patch.
> 
> >  to know when the processing is finished it can set the
> > VIRTIO_GPU_FLAG_FENCE flag in the request.  The device MUST finish the
> > @@ -345,7 +345,7 @@ \subsubsection{Device Operation:
> > controlq}\label{sec:Device Types / GPU Device /  display).
> >
> >  The \field{enabled} field is set when the user enabled the display.
> 
> I am not sure if it is `enables` instead of `enabled`.
> 
You are right for both the comments.
Will send separate patch to fix them.

Thank you for the review of the series.

> > -It is roughly the same as the connected state of a phyiscal display
> > +It is roughly the same as the connected state of a physical display
> >  connector.
> >
> >  \item[VIRTIO_GPU_CMD_GET_EDID] Retrieve the EDID data for a given
> > --
> > 2.34.1
> >
> >
> 
> Reviewed-by: Matias Ezequiel Vara Larsen <mvaralar@redhat.com>
> 
> Thanks, Matias.

[PATCH 3/3] common: editorial: Fix spelling errors

[Parav Pandit]

Fix spelling errors.

Branch: virtio-1.4
Fixes: 5f1a8ac61c15 ("admin: introduce virtio admin virtqueues")
Fixes: 68f66ff7a3d9 ("content: define what an exported object is")
Fixes: ef16b644cc25 ("content.tex: spec text converted to latex")
Signed-off-by: Parav Pandit <parav@nvidia.com>
---
 admin.tex   | 2 +-
 content.tex | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/admin.tex b/admin.tex
index 95054ed..845ca02 100644
--- a/admin.tex
+++ b/admin.tex
@@ -496,7 +496,7 @@ \section{Administration Virtqueues}\label{sec:Basic Facilities of a Virtio Devic
 than one administration virtqueue.
 
 If VIRTIO_F_ADMIN_VQ has been negotiated, an owner device exposes one
-or more adminstration virtqueues. The number and locations of the
+or more administration virtqueues. The number and locations of the
 administration virtqueues are exposed by the owner device in a transport
 specific manner.
 
diff --git a/content.tex b/content.tex
index 12f9224..c5e7d5a 100644
--- a/content.tex
+++ b/content.tex
@@ -493,7 +493,7 @@ \section{Driver Notifications} \label{sec:Basic Facilities of a Virtio Device /
 \section{Exporting Objects}\label{sec:Basic Facilities of a Virtio Device / Exporting Objects}
 
 When an object created by one virtio device needs to be
-shared with a seperate virtio device, the first device can
+shared with a separate virtio device, the first device can
 export the object by generating a UUID which can then
 be passed to the second device to identify the object.
 
@@ -508,7 +508,7 @@ \section{Exporting Objects}\label{sec:Basic Facilities of a Virtio Device / Expo
 \chapter{General Initialization And Device Operation}\label{sec:General Initialization And Device Operation}
 
 We start with an overview of device initialization, then expand on the
-details of the device and how each step is preformed.  This section
+details of the device and how each step is performed.  This section
 is best read along with the bus-specific section which describes
 how to communicate with the specific device.
 
-- 
2.34.1

Re: [PATCH 3/3] common: editorial: Fix spelling errors

[Matias Ezequiel Vara Larsen]

On Sat, Sep 07, 2024 at 08:48:19PM +0300, Parav Pandit wrote:
> Fix spelling errors.
> 
> Branch: virtio-1.4
> Fixes: 5f1a8ac61c15 ("admin: introduce virtio admin virtqueues")
> Fixes: 68f66ff7a3d9 ("content: define what an exported object is")
> Fixes: ef16b644cc25 ("content.tex: spec text converted to latex")
> Signed-off-by: Parav Pandit <parav@nvidia.com>
> ---
>  admin.tex   | 2 +-
>  content.tex | 4 ++--
>  2 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/admin.tex b/admin.tex
> index 95054ed..845ca02 100644
> --- a/admin.tex
> +++ b/admin.tex
> @@ -496,7 +496,7 @@ \section{Administration Virtqueues}\label{sec:Basic Facilities of a Virtio Devic
>  than one administration virtqueue.
>  
>  If VIRTIO_F_ADMIN_VQ has been negotiated, an owner device exposes one
> -or more adminstration virtqueues. The number and locations of the
> +or more administration virtqueues. The number and locations of the
>  administration virtqueues are exposed by the owner device in a transport
>  specific manner.
>  
> diff --git a/content.tex b/content.tex
> index 12f9224..c5e7d5a 100644
> --- a/content.tex
> +++ b/content.tex
> @@ -493,7 +493,7 @@ \section{Driver Notifications} \label{sec:Basic Facilities of a Virtio Device /
>  \section{Exporting Objects}\label{sec:Basic Facilities of a Virtio Device / Exporting Objects}
>  
>  When an object created by one virtio device needs to be
> -shared with a seperate virtio device, the first device can
> +shared with a separate virtio device, the first device can
>  export the object by generating a UUID which can then
>  be passed to the second device to identify the object.
>  
> @@ -508,7 +508,7 @@ \section{Exporting Objects}\label{sec:Basic Facilities of a Virtio Device / Expo
>  \chapter{General Initialization And Device Operation}\label{sec:General Initialization And Device Operation}
>  
>  We start with an overview of device initialization, then expand on the
> -details of the device and how each step is preformed.  This section
> +details of the device and how each step is performed.  This section
>  is best read along with the bus-specific section which describes
>  how to communicate with the specific device.
>  
> -- 
> 2.34.1
> 
> 

Reviewed-by: Matias Ezequiel Vara Larsen <mvaralar@redhat.com>

Thanks.