[virtio-dev] [PATCH] admin: Fix reference and table formation

[virtio-dev] [PATCH] admin: Fix reference and table formation

[Parav Pandit]

This patch brings three fixes.

1. Opcode table has 3 columns, only two were enumerated. Due to this
pdf generation script stops. Fix it and also have resizeable description
column as it needs wrap.

2. Status description column content needs to wrap. Without it pdf
   does not read good. Fix it by having resizeable description column.

3. Fix the broken link to the Device groups.

This fix is for [1].

[1] https://lore.kernel.org/virtio-comment/cover.1683301091.git.mst@redhat.com/T/#t

Signed-off-by: Parav Pandit <parav@nvidia.com>
---
 admin.tex | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/admin.tex b/admin.tex
index 6bfc1c9..47556f3 100644
--- a/admin.tex
+++ b/admin.tex
@@ -109,7 +109,7 @@ \subsection{Group administration commands}\label{sec:Basic Facilities of a Virti
 \field{opcode} specifies the command. The valid
 values for \field{opcode} can be found in the following table:
 
-\begin{tabular}{|l|l|}
+\begin{tabularx}{\textwidth}{ |l||l|X| }
 \hline
 opcode & Name & Command Description \\
 \hline \hline
@@ -119,11 +119,11 @@ \subsection{Group administration commands}\label{sec:Basic Facilities of a Virti
 \hline
 0x8000 - 0xFFFF & - & Reserved for future commands (possibly using a different structure)    \\
 \hline
-\end{tabular}
+\end{tabularx}
 
 The \field{group_type} specifies the group type identifier.
 The \field{group_member_id} specifies the member identifier within the group.
-See section \ref{sec:Introduction / Terminology / Device group}
+See section \ref{sec:Basic Facilities of a Virtio Device / Device groups}
 for the definition of the group type identifier and group member
 identifier.
 
@@ -155,7 +155,8 @@ \subsection{Group administration commands}\label{sec:Basic Facilities of a Virti
 is reserved and set to zero by the device.
 
 The following table describes possible \field{status_qualifier} values:
-\begin{tabular}{|l|l|l|}
+
+\begin{tabularx}{\textwidth}{ |l||l|X| }
 \hline
 Status & Name & Description \\
 \hline \hline
@@ -177,7 +178,7 @@ \subsection{Group administration commands}\label{sec:Basic Facilities of a Virti
 \hline
 0x08-0xFFFF   & -    & reserved for future use \\
 \hline
-\end{tabular}
+\end{tabularx}
 
 Each command uses a different \field{command_specific_data} and
 \field{command_specific_result} structures and the length of
-- 
2.26.2


---------------------------------------------------------------------
To unsubscribe, e-mail: virtio-dev-unsubscribe@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-help@lists.oasis-open.org

[virtio-comment] [PATCH] admin: Fix reference and table formation

[Parav Pandit]

This patch brings three fixes.

1. Opcode table has 3 columns, only two were enumerated. Due to this
pdf generation script stops. Fix it and also have resizeable description
column as it needs wrap.

2. Status description column content needs to wrap. Without it pdf
   does not read good. Fix it by having resizeable description column.

3. Fix the broken link to the Device groups.

This fix is for [1].

[1] https://lore.kernel.org/virtio-comment/cover.1683301091.git.mst@redhat.com/T/#t

Signed-off-by: Parav Pandit <parav@nvidia.com>
---
 admin.tex | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/admin.tex b/admin.tex
index 6bfc1c9..47556f3 100644
--- a/admin.tex
+++ b/admin.tex
@@ -109,7 +109,7 @@ \subsection{Group administration commands}\label{sec:Basic Facilities of a Virti
 \field{opcode} specifies the command. The valid
 values for \field{opcode} can be found in the following table:
 
-\begin{tabular}{|l|l|}
+\begin{tabularx}{\textwidth}{ |l||l|X| }
 \hline
 opcode & Name & Command Description \\
 \hline \hline
@@ -119,11 +119,11 @@ \subsection{Group administration commands}\label{sec:Basic Facilities of a Virti
 \hline
 0x8000 - 0xFFFF & - & Reserved for future commands (possibly using a different structure)    \\
 \hline
-\end{tabular}
+\end{tabularx}
 
 The \field{group_type} specifies the group type identifier.
 The \field{group_member_id} specifies the member identifier within the group.
-See section \ref{sec:Introduction / Terminology / Device group}
+See section \ref{sec:Basic Facilities of a Virtio Device / Device groups}
 for the definition of the group type identifier and group member
 identifier.
 
@@ -155,7 +155,8 @@ \subsection{Group administration commands}\label{sec:Basic Facilities of a Virti
 is reserved and set to zero by the device.
 
 The following table describes possible \field{status_qualifier} values:
-\begin{tabular}{|l|l|l|}
+
+\begin{tabularx}{\textwidth}{ |l||l|X| }
 \hline
 Status & Name & Description \\
 \hline \hline
@@ -177,7 +178,7 @@ \subsection{Group administration commands}\label{sec:Basic Facilities of a Virti
 \hline
 0x08-0xFFFF   & -    & reserved for future use \\
 \hline
-\end{tabular}
+\end{tabularx}
 
 Each command uses a different \field{command_specific_data} and
 \field{command_specific_result} structures and the length of
-- 
2.26.2


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-dev] Re: [virtio-comment] [PATCH] admin: Fix reference and table formation

[Cornelia Huck]

On Fri, May 05 2023, Parav Pandit <parav@nvidia.com> wrote:

> This patch brings three fixes.
>
> 1. Opcode table has 3 columns, only two were enumerated. Due to this
> pdf generation script stops. Fix it and also have resizeable description
> column as it needs wrap.
>
> 2. Status description column content needs to wrap. Without it pdf
>    does not read good. Fix it by having resizeable description column.
>
> 3. Fix the broken link to the Device groups.
>
> This fix is for [1].
>
> [1] https://lore.kernel.org/virtio-comment/cover.1683301091.git.mst@redhat.com/T/#t
>
> Signed-off-by: Parav Pandit <parav@nvidia.com>
> ---
>  admin.tex | 11 ++++++-----
>  1 file changed, 6 insertions(+), 5 deletions(-)

Reviewed-by: Cornelia Huck <cohuck@redhat.com>

Let's push this as an editorial change once the main series is merged.


---------------------------------------------------------------------
To unsubscribe, e-mail: virtio-dev-unsubscribe@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-help@lists.oasis-open.org

Re: [virtio-comment] [PATCH] admin: Fix reference and table formation

[Cornelia Huck]

On Fri, May 05 2023, Parav Pandit <parav@nvidia.com> wrote:

> This patch brings three fixes.
>
> 1. Opcode table has 3 columns, only two were enumerated. Due to this
> pdf generation script stops. Fix it and also have resizeable description
> column as it needs wrap.
>
> 2. Status description column content needs to wrap. Without it pdf
>    does not read good. Fix it by having resizeable description column.
>
> 3. Fix the broken link to the Device groups.
>
> This fix is for [1].
>
> [1] https://lore.kernel.org/virtio-comment/cover.1683301091.git.mst@redhat.com/T/#t
>
> Signed-off-by: Parav Pandit <parav@nvidia.com>
> ---
>  admin.tex | 11 ++++++-----
>  1 file changed, 6 insertions(+), 5 deletions(-)

Reviewed-by: Cornelia Huck <cohuck@redhat.com>

Let's push this as an editorial change once the main series is merged.


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/