Skip to contentSkip to conversation

editorial: replace hyperref with ref

PATCH In review Parav Pandit 4 participants 9 messages Jul 12, 2024 – Jul 14, 2024

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 editorial: replace hyperref with ref

Replace hyperreference with the reference.
Fix the broken link refernce for the DEVICE_STATUS part.

---
 admin-cmds-device-parts.tex     |  6 +++---
 admin-cmds-resource-objects.tex |  2 +-
 device-parts.tex                | 19 ++++++++++---------
 3 files changed, 14 insertions(+), 13 deletions(-)
admin-cmds-device-parts.tex +3 -3
index ab6e83b..4aa1464 100644
@@ -60,7 +60,7 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev
 Before performing any get or set operation for the device parts, the driver
 creates the device parts resource object
 VIRTIO_RESOURCE_OBJ_DEV_PARTS using the administration command
-\hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE]{VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE}.
+\ref{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE}.
 The driver indicates the intended purpose (get or set) at the time of creating the
 device parts resource object.
 For the device parts resource object, both \field{resource_obj_specific_data} and
@@ -337,7 +337,7 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev
 When there are multiple device parts in the command
 VIRTIO_ADMIN_CMD_DEV_PARTS_GET, the device MUST respond the device parts in the
 same order as listed in the table
-\hyperref[table:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts order/ Device parts order]{device parts order}.
+\ref{table:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts order/ Device parts order}.
 
 The device SHOULD respond with an error status for the command
 VIRTIO_ADMIN_CMD_DEV_PARTS_SET if the device is not stopped.
@@ -455,7 +455,7 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev
 When there are multiple device parts in the command
 VIRTIO_ADMIN_CMD_DEV_PARTS_SET, the driver MUST set the device parts in the same
 order as listed in the table
-\hyperref[table:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts order/ Device parts order]{device parts order}.
+\ref{table:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts order/ Device parts order}.
 
 For the SR-IOV group type, the driver SHOULD NOT access the device configuration
 space described in section
admin-cmds-resource-objects.tex +1 -1
index 388aa69..d0a6647 100644
@@ -69,7 +69,7 @@ \subsubsection{Device resource objects}\label{sec:Basic Facilities of a Virtio D
 \hline
 Resource object type & Name & Description \\
 \hline \hline
-0x000 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / VIRTIO_RESOURCE_OBJ_DEV_PARTS]{VIRTIO_RESOURCE_OBJ_DEV_PARTS} & Device parts object \\
+0x000 & VIRTIO_RESOURCE_OBJ_DEV_PARTS & Device parts object, see \ref{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / VIRTIO_RESOURCE_OBJ_DEV_PARTS} \\
 \hline
 0x001-0x1ff & - & Generic resource object range reserved \\
 \hline
device-parts.tex +10 -9
index 7384408..47ad06d 100644
@@ -70,7 +70,7 @@ \section{Device parts}\label{sec:Basic Facilities of a Virtio Device / Device pa
 \field{part_type} values.
 
 \field{selector.pci_common_cfg.offset} is the offset of the
-field in the \hyperref[sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Common configuration structure layout]{Virtio PCI common config space}. It is valid only when the \field{part_type} is set to VIRTIO_DEV_PART_PCI_COMMON_CFG,
+field in the \ref{sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Common configuration structure layout}. It is valid only when the \field{part_type} is set to VIRTIO_DEV_PART_PCI_COMMON_CFG,
 otherwise it is reserved and set to 0.
 
 \field{selector.vq_index.index} is the index of the virtqueue. It is valid
@@ -89,17 +89,17 @@ \subsection{Common device parts}\label{sec:Basic Facilities of a Virtio Device /
 \hline
 Type & Name & Description \\
 \hline \hline
-0x100 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEV_FEATURES]{VIRTIO_DEV_PART_DEV_FEATURES} & Device features \\
+0x100 & VIRTIO_DEV_PART_DEV_FEATURES & Device features, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEV_FEATURES} \\
 \hline
-0x101 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DRV_FEATURES]{VIRTIO_DEV_PART_DRV_FEATURES} & Driver features \\
+0x101 & VIRTIO_DEV_PART_DRV_FEATURES & Driver features, \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DRV_FEATURES} \\
 \hline
-0x102 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_PCI_COMMON_CFG]{VIRTIO_DEV_PART_PCI_COMMON_CFG} & PCI common configuration \\
+0x102 & VIRTIO_DEV_PART_PCI_COMMON_CFG & PCI common configuration, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_PCI_COMMON_CFG} \\
 \hline
-0x103 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEVICE_STATUS]{VIRTIO_DEV_PART_DEVICE_STATUS} & Device status \\
+0x103 & VIRTIO_DEV_PART_DEVICE_STATUS & Device status, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEVICE_STATUS} \\
 \hline
-0x104 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_CFG]{VIRTIO_DEV_PART_VQ_CFG} & Virtqueue configuration \\
+0x104 & VIRTIO_DEV_PART_VQ_CFG & Virtqueue configuration, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_CFG} \\
 \hline
-0x105 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_NOTIFY_CFG]{VIRTIO_DEV_PART_VQ_NOTIFY_CFG} & Virtqueue notification configuration \\
+0x105 & VIRTIO_DEV_PART_VQ_NOTIFY_CFG & Virtqueue notification configuration, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_NOTIFY_CFG} \\
 \hline
 0x106 - 0x2FF & - & Common device parts range reserved for future \\
 \hline
@@ -157,7 +157,8 @@ \subsubsection{VIRTIO_DEV_PART_PCI_COMMON_CFG}
 One or multiple VIRTIO_DEV_PART_PCI_COMMON_CFG parts may exist in the
 get or set commands; each such part corresponds to a unique \field{offset}.
 
-\subsubsection{VIRTIO_DEV_PART_DEVICE_STATUS}\label{par:VIRTIO_DEV_PART_DEVICE_STATUS}
+\subsubsection{VIRTIO_DEV_PART_DEVICE_STATUS}
+\label{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEVICE_STATUS}
 
 For VIRTIO_DEV_PART_DEVICE_STATUS, \field{part_type} is set to 0x103.
 The VIRTIO_DEV_PART_DEVICE_STATUS field indicates the device status as listed in
@@ -215,7 +216,7 @@ \subsubsection{VIRTIO_DEV_PART_VQ_NOTIFY_CFG}
 
 \field{queue_notify_off} and \field{queue_notif_config_data} corresponds to the
 fields in \field{struct virtio_pci_common_cfg} described in
-\hyperref[sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Common configuration structure layout]{Virtio PCI common configuration space}.
+\ref{sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Common configuration structure layout}.
 
 One or multiple instance of the device part VIRTIO_DEV_PART_VQ_NOTIFY_CFG may exist
 in the get and set commands, each such device part corresponds to a unique
Signature · 1 line
2.34.1
#1 lore raw
Quoted 10 lines · Parav Pandit

Replace hyperreference with the reference.
Fix the broken link refernce for the DEVICE_STATUS part.

---
 admin-cmds-device-parts.tex     |  6 +++---
 admin-cmds-resource-objects.tex |  2 +-
 device-parts.tex                | 19 ++++++++++---------
 3 files changed, 14 insertions(+), 13 deletions(-)

What is this patch against?

#2 lore raw
Quoted 13 lines · Cornelia Huck
Quoted 10 lines · Parav Pandit

Replace hyperreference with the reference.
Fix the broken link refernce for the DEVICE_STATUS part.

---
 admin-cmds-device-parts.tex     |  6 +++---
 admin-cmds-resource-objects.tex |  2 +-
 device-parts.tex                | 19 ++++++++++---------
 3 files changed, 14 insertions(+), 13 deletions(-)
Quoted 1 line

What is this patch against?

...seemingly it goes with the patches in the pull req you sent right afterwards. Please always state the base.

#3 lore raw
Quoted 24 lines

From: Cornelia Huck <[email protected]>
Sent: Friday, July 12, 2024 4:17 PM
To: Parav Pandit <[email protected]>; [email protected]; [email protected]
Cc: Parav Pandit <[email protected]>
Subject: Re: [PATCH] editorial: replace hyperref with ref

Quoted 13 lines · Cornelia Huck
Quoted 10 lines · Parav Pandit

Replace hyperreference with the reference.
Fix the broken link refernce for the DEVICE_STATUS part.

---
 admin-cmds-device-parts.tex     |  6 +++---
 admin-cmds-resource-objects.tex |  2 +-
 device-parts.tex                | 19 ++++++++++---------
 3 files changed, 14 insertions(+), 13 deletions(-)
Quoted 4 lines
Quoted 1 line

What is this patch against?

...seemingly it goes with the patches in the pull req you sent right afterwards. Please always state the base.

Will do. Thanks.

#4 lore raw
In reply to Parav Pandit
Quoted 2 lines · Parav Pandit

Replace hyperreference with the reference.
Fix the broken link refernce for the DEVICE_STATUS part.

typo

Quoted 23 lines
---
 admin-cmds-device-parts.tex     |  6 +++---
 admin-cmds-resource-objects.tex |  2 +-
 device-parts.tex                | 19 ++++++++++---------
 3 files changed, 14 insertions(+), 13 deletions(-)
admin-cmds-device-parts.tex +1 -1
index ab6e83b..4aa1464 100644
@@ -60,7 +60,7 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev
 Before performing any get or set operation for the device parts, the driver
 creates the device parts resource object
 VIRTIO_RESOURCE_OBJ_DEV_PARTS using the administration command
-\hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE]{VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE}.
+\ref{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE}.
 The driver indicates the intended purpose (get or set) at the time of creating the
 device parts resource object.
 For the device parts resource object, both \field{resource_obj_specific_data} and

admin-cmds-device-parts.tex \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev · line 340

Quoted 5 lines
admin-cmds-device-parts.tex +1 -1
@@ -337,7 +337,7 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev
 When there are multiple device parts in the command
 VIRTIO_ADMIN_CMD_DEV_PARTS_GET, the device MUST respond the device parts in the
 same order as listed in the table
-\hyperref[table:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts order/ Device parts order]{device parts order}.
+\ref{table:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts order/ Device parts order}.

Should be part of sentence before: {device parts order} \ref{}.

Otherwise it's just a reference by itself, does not make sense - pls look at the generated pdf to see what I mean.

Same elsewhere.

Quoted 83 lines
admin-cmds-device-parts.tex +1 -1
 The device SHOULD respond with an error status for the command
 VIRTIO_ADMIN_CMD_DEV_PARTS_SET if the device is not stopped.
@@ -455,7 +455,7 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev
 When there are multiple device parts in the command
 VIRTIO_ADMIN_CMD_DEV_PARTS_SET, the driver MUST set the device parts in the same
 order as listed in the table
-\hyperref[table:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts order/ Device parts order]{device parts order}.
+\ref{table:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts order/ Device parts order}.
 
 For the SR-IOV group type, the driver SHOULD NOT access the device configuration
 space described in section
admin-cmds-resource-objects.tex +1 -1
index 388aa69..d0a6647 100644
@@ -69,7 +69,7 @@ \subsubsection{Device resource objects}\label{sec:Basic Facilities of a Virtio D
 \hline
 Resource object type & Name & Description \\
 \hline \hline
-0x000 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / VIRTIO_RESOURCE_OBJ_DEV_PARTS]{VIRTIO_RESOURCE_OBJ_DEV_PARTS} & Device parts object \\
+0x000 & VIRTIO_RESOURCE_OBJ_DEV_PARTS & Device parts object, see \ref{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / VIRTIO_RESOURCE_OBJ_DEV_PARTS} \\
 \hline
 0x001-0x1ff & - & Generic resource object range reserved \\
 \hline
device-parts.tex +10 -9
index 7384408..47ad06d 100644
@@ -70,7 +70,7 @@ \section{Device parts}\label{sec:Basic Facilities of a Virtio Device / Device pa
 \field{part_type} values.
 
 \field{selector.pci_common_cfg.offset} is the offset of the
-field in the \hyperref[sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Common configuration structure layout]{Virtio PCI common config space}. It is valid only when the \field{part_type} is set to VIRTIO_DEV_PART_PCI_COMMON_CFG,
+field in the \ref{sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Common configuration structure layout}. It is valid only when the \field{part_type} is set to VIRTIO_DEV_PART_PCI_COMMON_CFG,
 otherwise it is reserved and set to 0.
 
 \field{selector.vq_index.index} is the index of the virtqueue. It is valid
@@ -89,17 +89,17 @@ \subsection{Common device parts}\label{sec:Basic Facilities of a Virtio Device /
 \hline
 Type & Name & Description \\
 \hline \hline
-0x100 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEV_FEATURES]{VIRTIO_DEV_PART_DEV_FEATURES} & Device features \\
+0x100 & VIRTIO_DEV_PART_DEV_FEATURES & Device features, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEV_FEATURES} \\
 \hline
-0x101 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DRV_FEATURES]{VIRTIO_DEV_PART_DRV_FEATURES} & Driver features \\
+0x101 & VIRTIO_DEV_PART_DRV_FEATURES & Driver features, \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DRV_FEATURES} \\
 \hline
-0x102 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_PCI_COMMON_CFG]{VIRTIO_DEV_PART_PCI_COMMON_CFG} & PCI common configuration \\
+0x102 & VIRTIO_DEV_PART_PCI_COMMON_CFG & PCI common configuration, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_PCI_COMMON_CFG} \\
 \hline
-0x103 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEVICE_STATUS]{VIRTIO_DEV_PART_DEVICE_STATUS} & Device status \\
+0x103 & VIRTIO_DEV_PART_DEVICE_STATUS & Device status, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEVICE_STATUS} \\
 \hline
-0x104 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_CFG]{VIRTIO_DEV_PART_VQ_CFG} & Virtqueue configuration \\
+0x104 & VIRTIO_DEV_PART_VQ_CFG & Virtqueue configuration, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_CFG} \\
 \hline
-0x105 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_NOTIFY_CFG]{VIRTIO_DEV_PART_VQ_NOTIFY_CFG} & Virtqueue notification configuration \\
+0x105 & VIRTIO_DEV_PART_VQ_NOTIFY_CFG & Virtqueue notification configuration, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_NOTIFY_CFG} \\
 \hline
 0x106 - 0x2FF & - & Common device parts range reserved for future \\
 \hline
@@ -157,7 +157,8 @@ \subsubsection{VIRTIO_DEV_PART_PCI_COMMON_CFG}
 One or multiple VIRTIO_DEV_PART_PCI_COMMON_CFG parts may exist in the
 get or set commands; each such part corresponds to a unique \field{offset}.
 
-\subsubsection{VIRTIO_DEV_PART_DEVICE_STATUS}\label{par:VIRTIO_DEV_PART_DEVICE_STATUS}
+\subsubsection{VIRTIO_DEV_PART_DEVICE_STATUS}
+\label{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEVICE_STATUS}
 
 For VIRTIO_DEV_PART_DEVICE_STATUS, \field{part_type} is set to 0x103.
 The VIRTIO_DEV_PART_DEVICE_STATUS field indicates the device status as listed in
@@ -215,7 +216,7 @@ \subsubsection{VIRTIO_DEV_PART_VQ_NOTIFY_CFG}
 
 \field{queue_notify_off} and \field{queue_notif_config_data} corresponds to the
 fields in \field{struct virtio_pci_common_cfg} described in
-\hyperref[sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Common configuration structure layout]{Virtio PCI common configuration space}.
+\ref{sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Common configuration structure layout}.
 
 One or multiple instance of the device part VIRTIO_DEV_PART_VQ_NOTIFY_CFG may exist
 in the get and set commands, each such device part corresponds to a unique
Signature · 1 line
2.34.1
#5 lore raw
Quoted 10 lines

From: Michael S. Tsirkin <[email protected]>
Sent: Friday, July 12, 2024 4:22 PM

Quoted 2 lines · Parav Pandit

Replace hyperreference with the reference.
Fix the broken link refernce for the DEVICE_STATUS part.

typo

Fixing in v1.

Quoted 39 lines
Quoted 14 lines
---
 admin-cmds-device-parts.tex     |  6 +++---
 admin-cmds-resource-objects.tex |  2 +-
 device-parts.tex                | 19 ++++++++++---------
 3 files changed, 14 insertions(+), 13 deletions(-)
admin-cmds-device-parts.tex +0 -0
index ab6e83b..4aa1464 100644
@@ -60,7 +60,7 @@ \subsubsection{Device parts}\label{sec:Basic
Quoted 4 lines

Facilities of a Virtio Device / Dev Before performing any get or set operation for the device parts, the driver creates the device parts resource object VIRTIO_RESOURCE_OBJ_DEV_PARTS using the administration command -\hyperref[par:Basic Facilities of a Virtio Device /

Device groups / Group administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE]{VIRTIO_ADMIN_CMD_RESO URCE_OBJ_CREATE}.

Quoted 1 line

+\ref{par:Basic Facilities of a Virtio Device / Device groups / Group

administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE}.

Quoted 7 lines

The driver indicates the intended purpose (get or set) at the time of
creating the device parts resource object.
For the device parts resource object, both
\field{resource_obj_specific_data} and @@ -337,7 +337,7 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev When there are multiple device parts in the command VIRTIO_ADMIN_CMD_DEV_PARTS_GET, the device MUST respond the

device

Quoted 1 line

parts in the same order as listed in the table -\hyperref[table:Basic Facilities

of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts order/ Device parts order]{device parts order}.

Quoted 1 line

+\ref{table:Basic Facilities of a Virtio Device / Device groups / Group

administration commands / Device parts / Device parts order/ Device parts order}.

Quoted 7 lines

Should be part of sentence before: {device parts order} \ref{}.

Otherwise it's just a reference by itself, does not make sense - pls look at the generated pdf to see what I mean.

Same elsewhere.

Ok. I use the name reference now which is readable with the reference. Thanks.

#6 lore raw
In reply to Parav Pandit
Quoted 2 lines · Parav Pandit

Replace hyperreference with the reference.
Fix the broken link refernce for the DEVICE_STATUS part.

BTW once you know the hash, add a Fixes tag here
for the patch it's fixing up.

Quoted 112 lines
---
 admin-cmds-device-parts.tex     |  6 +++---
 admin-cmds-resource-objects.tex |  2 +-
 device-parts.tex                | 19 ++++++++++---------
 3 files changed, 14 insertions(+), 13 deletions(-)
admin-cmds-device-parts.tex +3 -3
index ab6e83b..4aa1464 100644
@@ -60,7 +60,7 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev
 Before performing any get or set operation for the device parts, the driver
 creates the device parts resource object
 VIRTIO_RESOURCE_OBJ_DEV_PARTS using the administration command
-\hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE]{VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE}.
+\ref{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE}.
 The driver indicates the intended purpose (get or set) at the time of creating the
 device parts resource object.
 For the device parts resource object, both \field{resource_obj_specific_data} and
@@ -337,7 +337,7 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev
 When there are multiple device parts in the command
 VIRTIO_ADMIN_CMD_DEV_PARTS_GET, the device MUST respond the device parts in the
 same order as listed in the table
-\hyperref[table:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts order/ Device parts order]{device parts order}.
+\ref{table:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts order/ Device parts order}.
 
 The device SHOULD respond with an error status for the command
 VIRTIO_ADMIN_CMD_DEV_PARTS_SET if the device is not stopped.
@@ -455,7 +455,7 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev
 When there are multiple device parts in the command
 VIRTIO_ADMIN_CMD_DEV_PARTS_SET, the driver MUST set the device parts in the same
 order as listed in the table
-\hyperref[table:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts order/ Device parts order]{device parts order}.
+\ref{table:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts order/ Device parts order}.
 
 For the SR-IOV group type, the driver SHOULD NOT access the device configuration
 space described in section
admin-cmds-resource-objects.tex +1 -1
index 388aa69..d0a6647 100644
@@ -69,7 +69,7 @@ \subsubsection{Device resource objects}\label{sec:Basic Facilities of a Virtio D
 \hline
 Resource object type & Name & Description \\
 \hline \hline
-0x000 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / VIRTIO_RESOURCE_OBJ_DEV_PARTS]{VIRTIO_RESOURCE_OBJ_DEV_PARTS} & Device parts object \\
+0x000 & VIRTIO_RESOURCE_OBJ_DEV_PARTS & Device parts object, see \ref{par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / VIRTIO_RESOURCE_OBJ_DEV_PARTS} \\
 \hline
 0x001-0x1ff & - & Generic resource object range reserved \\
 \hline
device-parts.tex +10 -9
index 7384408..47ad06d 100644
@@ -70,7 +70,7 @@ \section{Device parts}\label{sec:Basic Facilities of a Virtio Device / Device pa
 \field{part_type} values.
 
 \field{selector.pci_common_cfg.offset} is the offset of the
-field in the \hyperref[sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Common configuration structure layout]{Virtio PCI common config space}. It is valid only when the \field{part_type} is set to VIRTIO_DEV_PART_PCI_COMMON_CFG,
+field in the \ref{sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Common configuration structure layout}. It is valid only when the \field{part_type} is set to VIRTIO_DEV_PART_PCI_COMMON_CFG,
 otherwise it is reserved and set to 0.
 
 \field{selector.vq_index.index} is the index of the virtqueue. It is valid
@@ -89,17 +89,17 @@ \subsection{Common device parts}\label{sec:Basic Facilities of a Virtio Device /
 \hline
 Type & Name & Description \\
 \hline \hline
-0x100 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEV_FEATURES]{VIRTIO_DEV_PART_DEV_FEATURES} & Device features \\
+0x100 & VIRTIO_DEV_PART_DEV_FEATURES & Device features, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEV_FEATURES} \\
 \hline
-0x101 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DRV_FEATURES]{VIRTIO_DEV_PART_DRV_FEATURES} & Driver features \\
+0x101 & VIRTIO_DEV_PART_DRV_FEATURES & Driver features, \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DRV_FEATURES} \\
 \hline
-0x102 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_PCI_COMMON_CFG]{VIRTIO_DEV_PART_PCI_COMMON_CFG} & PCI common configuration \\
+0x102 & VIRTIO_DEV_PART_PCI_COMMON_CFG & PCI common configuration, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_PCI_COMMON_CFG} \\
 \hline
-0x103 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEVICE_STATUS]{VIRTIO_DEV_PART_DEVICE_STATUS} & Device status \\
+0x103 & VIRTIO_DEV_PART_DEVICE_STATUS & Device status, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEVICE_STATUS} \\
 \hline
-0x104 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_CFG]{VIRTIO_DEV_PART_VQ_CFG} & Virtqueue configuration \\
+0x104 & VIRTIO_DEV_PART_VQ_CFG & Virtqueue configuration, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_CFG} \\
 \hline
-0x105 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_NOTIFY_CFG]{VIRTIO_DEV_PART_VQ_NOTIFY_CFG} & Virtqueue notification configuration \\
+0x105 & VIRTIO_DEV_PART_VQ_NOTIFY_CFG & Virtqueue notification configuration, see \ref{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_NOTIFY_CFG} \\
 \hline
 0x106 - 0x2FF & - & Common device parts range reserved for future \\
 \hline
@@ -157,7 +157,8 @@ \subsubsection{VIRTIO_DEV_PART_PCI_COMMON_CFG}
 One or multiple VIRTIO_DEV_PART_PCI_COMMON_CFG parts may exist in the
 get or set commands; each such part corresponds to a unique \field{offset}.
 
-\subsubsection{VIRTIO_DEV_PART_DEVICE_STATUS}\label{par:VIRTIO_DEV_PART_DEVICE_STATUS}
+\subsubsection{VIRTIO_DEV_PART_DEVICE_STATUS}
+\label{sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEVICE_STATUS}
 
 For VIRTIO_DEV_PART_DEVICE_STATUS, \field{part_type} is set to 0x103.
 The VIRTIO_DEV_PART_DEVICE_STATUS field indicates the device status as listed in
@@ -215,7 +216,7 @@ \subsubsection{VIRTIO_DEV_PART_VQ_NOTIFY_CFG}
 
 \field{queue_notify_off} and \field{queue_notif_config_data} corresponds to the
 fields in \field{struct virtio_pci_common_cfg} described in
-\hyperref[sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Common configuration structure layout]{Virtio PCI common configuration space}.
+\ref{sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Common configuration structure layout}.
 
 One or multiple instance of the device part VIRTIO_DEV_PART_VQ_NOTIFY_CFG may exist
 in the get and set commands, each such device part corresponds to a unique
Signature · 1 line
2.34.1
#7 lore raw
Quoted 9 lines

From: Michael S. Tsirkin <[email protected]>
Sent: Friday, July 12, 2024 4:30 PM
To: Parav Pandit <[email protected]>
Cc: [email protected]; [email protected]; Parav Pandit <[email protected]>
Subject: Re: [PATCH] editorial: replace hyperref with ref

Quoted 6 lines
Quoted 2 lines · Parav Pandit

Replace hyperreference with the reference.
Fix the broken link refernce for the DEVICE_STATUS part.

BTW once you know the hash, add a Fixes tag here for the patch it's fixing up.

Yes, I am familiar with the flow.
Will do once, the patches are part of the branch. This patch is sent mainly to fix the editorial in the same PR. Hence, I skipped it.
Will follow in future patches.

Quoted 188 lines
Quoted 16 lines
---
 admin-cmds-device-parts.tex     |  6 +++---
 admin-cmds-resource-objects.tex |  2 +-
 device-parts.tex                | 19 ++++++++++---------
 3 files changed, 14 insertions(+), 13 deletions(-)
admin-cmds-device-parts.tex +0 -0
index ab6e83b..4aa1464 100644
@@ -60,7 +60,7 @@ \subsubsection{Device parts}\label{sec:Basic
Quoted 4 lines

Facilities of a Virtio Device / Dev Before performing any get or set operation for the device parts, the driver creates the device parts resource object VIRTIO_RESOURCE_OBJ_DEV_PARTS using the administration command -\hyperref[par:Basic Facilities of a Virtio Device /

Device groups / Group administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE]{VIRTIO_ADMIN_CMD_RESO URCE_OBJ_CREATE}.

Quoted 1 line

+\ref{par:Basic Facilities of a Virtio Device / Device groups / Group

administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE}.

Quoted 7 lines

The driver indicates the intended purpose (get or set) at the time of
creating the device parts resource object.
For the device parts resource object, both
\field{resource_obj_specific_data} and @@ -337,7 +337,7 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev When there are multiple device parts in the command VIRTIO_ADMIN_CMD_DEV_PARTS_GET, the device MUST respond the

device

Quoted 1 line

parts in the same order as listed in the table -\hyperref[table:Basic Facilities

of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts order/ Device parts order]{device parts order}.

Quoted 1 line

+\ref{table:Basic Facilities of a Virtio Device / Device groups / Group

administration commands / Device parts / Device parts order/ Device parts order}.

Quoted 6 lines

The device SHOULD respond with an error status for the command
VIRTIO_ADMIN_CMD_DEV_PARTS_SET if the device is not stopped.

admin-cmds-device-parts.tex +0 -0
@@ -455,7 +455,7 @@ \subsubsection{Device parts}\label{sec:Basic

Facilities of a Virtio Device / Dev When there are multiple device parts in the command VIRTIO_ADMIN_CMD_DEV_PARTS_SET, the driver

MUST

Quoted 2 lines

set the device parts in the same order as listed in the table -\hyperref[table:Basic Facilities of a Virtio Device / Device groups / Group

administration commands / Device parts / Device parts order/ Device parts order]{device parts order}.

Quoted 1 line

+\ref{table:Basic Facilities of a Virtio Device / Device groups / Group

administration commands / Device parts / Device parts order/ Device parts order}.

Quoted 8 lines

For the SR-IOV group type, the driver SHOULD NOT access the device
configuration space described in section diff --git a/admin-cmds-resource-objects.tex b/admin-cmds-resource-objects.tex index 388aa69..d0a6647 100644

admin-cmds-resource-objects.tex +0 -0
@@ -69,7 +69,7 @@ \subsubsection{Device resource
Quoted 5 lines

objects}\label{sec:Basic Facilities of a Virtio D \hline Resource object type & Name & Description \\ \hline \hline -0x000 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / VIRTIO_RESOURCE_OBJ_DEV_PARTS]{VIRTIO_RESOURCE_OBJ_DEV_PARTS}

& Device

Quoted 26 lines

parts object \\
+0x000 & VIRTIO_RESOURCE_OBJ_DEV_PARTS & Device parts object, see +\ref{par:Basic Facilities of a Virtio Device / Device groups / Group

admin-cmds-resource-objects.tex +2 -0
+administration commands / Device parts /
+VIRTIO_RESOURCE_OBJ_DEV_PARTS} \\
 \hline
 0x001-0x1ff & - & Generic resource object range reserved \\  \hline
device-parts.tex index renamed from device-parts.tex +0 -0

7384408..47ad06d 100644

device-parts.tex +0 -0
@@ -70,7 +70,7 @@ \section{Device parts}\label{sec:Basic Facilities of

a Virtio Device / Device pa \field{part_type} values.

\field{selector.pci_common_cfg.offset} is the offset of the -field in
the \hyperref[sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Common configuration structure layout]{Virtio PCI common config space}. It is valid only when the \field{part_type} is set to VIRTIO_DEV_PART_PCI_COMMON_CFG,

device-parts.tex +4 -0
+field in the \ref{sec:Virtio Transport Options / Virtio Over PCI Bus
+/ PCI Device Layout / Common configuration structure layout}. It is
+valid only when the \field{part_type} is set to
+VIRTIO_DEV_PART_PCI_COMMON_CFG,
 otherwise it is reserved and set to 0.
 
 \field{selector.vq_index.index} is the index of the virtqueue. It is
Quoted 6 lines

valid @@ -89,17 +89,17 @@ \subsection{Common device parts}\label{sec:Basic Facilities of a Virtio Device / \hline Type & Name & Description \\ \hline \hline
-0x100 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEV_FEATURES]{VIRTIO_DEV_PART_DEV_FEATURES} &

Device

Quoted 8 lines

features \\
+0x100 & VIRTIO_DEV_PART_DEV_FEATURES & Device features, see +\ref{sec:Basic Facilities of a Virtio Device / Device parts / Common +device parts / VIRTIO_DEV_PART_DEV_FEATURES} \\
\hline
-0x101 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DRV_FEATURES]{VIRTIO_DEV_PART_DRV_FEATURES} &

Driver

Quoted 8 lines

features \\
+0x101 & VIRTIO_DEV_PART_DRV_FEATURES & Driver features, +\ref{sec:Basic Facilities of a Virtio Device / Device parts / Common +device parts / VIRTIO_DEV_PART_DRV_FEATURES} \\
\hline
-0x102 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts /

VIRTIO_DEV_PART_PCI_COMMON_CFG]{VIRTIO_DEV_PART_PCI_COMMON_ CFG} & PCI

Quoted 2 lines

common configuration \\
+0x102 & VIRTIO_DEV_PART_PCI_COMMON_CFG & PCI common

configuration,

Quoted 6 lines
device-parts.tex +2 -1
+see \ref{sec:Basic Facilities of a Virtio Device / Device parts /
+Common device parts / VIRTIO_DEV_PART_PCI_COMMON_CFG} \\
 \hline
-0x103 & \hyperref[sec:Basic Facilities of a Virtio Device / Device

parts / Common device parts / VIRTIO_DEV_PART_DEVICE_STATUS]{VIRTIO_DEV_PART_DEVICE_STATUS}

& Device

Quoted 8 lines

status \\
+0x103 & VIRTIO_DEV_PART_DEVICE_STATUS & Device status, see +\ref{sec:Basic Facilities of a Virtio Device / Device parts / Common +device parts / VIRTIO_DEV_PART_DEVICE_STATUS} \\
\hline
-0x104 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_CFG]{VIRTIO_DEV_PART_VQ_CFG} & Virtqueue

Quoted 8 lines

configuration \\
+0x104 & VIRTIO_DEV_PART_VQ_CFG & Virtqueue configuration, see +\ref{sec:Basic Facilities of a Virtio Device / Device parts / Common +device parts / VIRTIO_DEV_PART_VQ_CFG} \\
\hline
-0x105 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_NOTIFY_CFG]{VIRTIO_DEV_PART_VQ_NOTIFY_CFG}

&

device-parts.tex

Quoted 4 lines

Virtqueue notification configuration \\
+0x105 & VIRTIO_DEV_PART_VQ_NOTIFY_CFG & Virtqueue notification

device-parts.tex +2 -0
+configuration, see \ref{sec:Basic Facilities of a Virtio Device /
+Device parts / Common device parts /

VIRTIO_DEV_PART_VQ_NOTIFY_CFG}

Quoted 6 lines

+\\
\hline
0x106 - 0x2FF & - & Common device parts range reserved for future \\
\hline @@ -157,7 +157,8 @@ \subsubsection{VIRTIO_DEV_PART_PCI_COMMON_CFG}
One or multiple VIRTIO_DEV_PART_PCI_COMMON_CFG parts may exist in

the

Quoted 3 lines

get or set commands; each such part corresponds to a unique \field{offset}.

-

\subsubsection{VIRTIO_DEV_PART_DEVICE_STATUS}\label{par:VIRTIO_DEV_P A

Quoted 5 lines

RT_DEVICE_STATUS} +\subsubsection{VIRTIO_DEV_PART_DEVICE_STATUS} +\label{sec:Basic Facilities of a Virtio Device / Device parts / +Common device parts / VIRTIO_DEV_PART_DEVICE_STATUS}

Quoted 8 lines

For VIRTIO_DEV_PART_DEVICE_STATUS, \field{part_type} is set to 0x103. The VIRTIO_DEV_PART_DEVICE_STATUS field indicates the device status
as listed in @@ -215,7 +216,7 @@ \subsubsection{VIRTIO_DEV_PART_VQ_NOTIFY_CFG}

\field{queue_notify_off} and \field{queue_notif_config_data}
corresponds to the fields in \field{struct virtio_pci_common_cfg} described in -\hyperref[sec:Virtio Transport Options / Virtio Over PCI Bus /

PCI Device Layout / Common configuration structure layout]{Virtio PCI common configuration space}.

Quoted 1 line

+\ref{sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout /

Common configuration structure layout}.

Quoted 3 lines

One or multiple instance of the device part
VIRTIO_DEV_PART_VQ_NOTIFY_CFG may exist in the get and set

commands,

Quoted 3 lines

each such device part corresponds to a unique
--
2.34.1

#8 lore raw
Quoted 10 lines · Parav Pandit
Quoted 10 lines

From: Michael S. Tsirkin <[email protected]>
Sent: Friday, July 12, 2024 4:30 PM
To: Parav Pandit <[email protected]>
Cc: [email protected]; [email protected]; Parav Pandit <[email protected]>
Subject: Re: [PATCH] editorial: replace hyperref with ref

On Fri, Jul 12, 2024 at 07:14:33AM +0300, Parav Pandit wrote:

Quoted 8 lines
Quoted 5 lines
Quoted 2 lines

Replace hyperreference with the reference.
Fix the broken link refernce for the DEVICE_STATUS part.

BTW once you know the hash, add a Fixes tag here for the patch it's fixing up.

Yes, I am familiar with the flow.
Will do once, the patches are part of the branch. This patch is sent mainly to fix the editorial in the same PR. Hence, I skipped it.

you can do it on the branch itself as opposed to in mail.

Quoted 190 lines

Will follow in future patches.

Quoted 188 lines
Quoted 16 lines
---
 admin-cmds-device-parts.tex     |  6 +++---
 admin-cmds-resource-objects.tex |  2 +-
 device-parts.tex                | 19 ++++++++++---------
 3 files changed, 14 insertions(+), 13 deletions(-)
admin-cmds-device-parts.tex +0 -0
index ab6e83b..4aa1464 100644
@@ -60,7 +60,7 @@ \subsubsection{Device parts}\label{sec:Basic
Quoted 4 lines

Facilities of a Virtio Device / Dev Before performing any get or set operation for the device parts, the driver creates the device parts resource object VIRTIO_RESOURCE_OBJ_DEV_PARTS using the administration command -\hyperref[par:Basic Facilities of a Virtio Device /

Device groups / Group administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE]{VIRTIO_ADMIN_CMD_RESO URCE_OBJ_CREATE}.

Quoted 1 line

+\ref{par:Basic Facilities of a Virtio Device / Device groups / Group

administration commands / Device resource objects / VIRTIO_ADMIN_CMD_RESOURCE_OBJ_CREATE}.

Quoted 7 lines

The driver indicates the intended purpose (get or set) at the time of
creating the device parts resource object.
For the device parts resource object, both
\field{resource_obj_specific_data} and @@ -337,7 +337,7 @@ \subsubsection{Device parts}\label{sec:Basic Facilities of a Virtio Device / Dev When there are multiple device parts in the command VIRTIO_ADMIN_CMD_DEV_PARTS_GET, the device MUST respond the

device

Quoted 1 line

parts in the same order as listed in the table -\hyperref[table:Basic Facilities

of a Virtio Device / Device groups / Group administration commands / Device parts / Device parts order/ Device parts order]{device parts order}.

Quoted 1 line

+\ref{table:Basic Facilities of a Virtio Device / Device groups / Group

administration commands / Device parts / Device parts order/ Device parts order}.

Quoted 6 lines

The device SHOULD respond with an error status for the command
VIRTIO_ADMIN_CMD_DEV_PARTS_SET if the device is not stopped.

admin-cmds-device-parts.tex +0 -0
@@ -455,7 +455,7 @@ \subsubsection{Device parts}\label{sec:Basic

Facilities of a Virtio Device / Dev When there are multiple device parts in the command VIRTIO_ADMIN_CMD_DEV_PARTS_SET, the driver

MUST

Quoted 2 lines

set the device parts in the same order as listed in the table -\hyperref[table:Basic Facilities of a Virtio Device / Device groups / Group

administration commands / Device parts / Device parts order/ Device parts order]{device parts order}.

Quoted 1 line

+\ref{table:Basic Facilities of a Virtio Device / Device groups / Group

administration commands / Device parts / Device parts order/ Device parts order}.

Quoted 8 lines

For the SR-IOV group type, the driver SHOULD NOT access the device
configuration space described in section diff --git a/admin-cmds-resource-objects.tex b/admin-cmds-resource-objects.tex index 388aa69..d0a6647 100644

admin-cmds-resource-objects.tex +0 -0
@@ -69,7 +69,7 @@ \subsubsection{Device resource
Quoted 5 lines

objects}\label{sec:Basic Facilities of a Virtio D \hline Resource object type & Name & Description \\ \hline \hline -0x000 & \hyperref[par:Basic Facilities of a Virtio Device / Device groups / Group administration commands / Device parts / VIRTIO_RESOURCE_OBJ_DEV_PARTS]{VIRTIO_RESOURCE_OBJ_DEV_PARTS}

& Device

Quoted 26 lines

parts object \\
+0x000 & VIRTIO_RESOURCE_OBJ_DEV_PARTS & Device parts object, see +\ref{par:Basic Facilities of a Virtio Device / Device groups / Group

admin-cmds-resource-objects.tex +2 -0
+administration commands / Device parts /
+VIRTIO_RESOURCE_OBJ_DEV_PARTS} \\
 \hline
 0x001-0x1ff & - & Generic resource object range reserved \\  \hline
device-parts.tex index renamed from device-parts.tex +0 -0

7384408..47ad06d 100644

device-parts.tex +0 -0
@@ -70,7 +70,7 @@ \section{Device parts}\label{sec:Basic Facilities of

a Virtio Device / Device pa \field{part_type} values.

\field{selector.pci_common_cfg.offset} is the offset of the -field in
the \hyperref[sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout / Common configuration structure layout]{Virtio PCI common config space}. It is valid only when the \field{part_type} is set to VIRTIO_DEV_PART_PCI_COMMON_CFG,

device-parts.tex +4 -0
+field in the \ref{sec:Virtio Transport Options / Virtio Over PCI Bus
+/ PCI Device Layout / Common configuration structure layout}. It is
+valid only when the \field{part_type} is set to
+VIRTIO_DEV_PART_PCI_COMMON_CFG,
 otherwise it is reserved and set to 0.
 
 \field{selector.vq_index.index} is the index of the virtqueue. It is
Quoted 6 lines

valid @@ -89,17 +89,17 @@ \subsection{Common device parts}\label{sec:Basic Facilities of a Virtio Device / \hline Type & Name & Description \\ \hline \hline
-0x100 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DEV_FEATURES]{VIRTIO_DEV_PART_DEV_FEATURES} &

Device

Quoted 8 lines

features \\
+0x100 & VIRTIO_DEV_PART_DEV_FEATURES & Device features, see +\ref{sec:Basic Facilities of a Virtio Device / Device parts / Common +device parts / VIRTIO_DEV_PART_DEV_FEATURES} \\
\hline
-0x101 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_DRV_FEATURES]{VIRTIO_DEV_PART_DRV_FEATURES} &

Driver

Quoted 8 lines

features \\
+0x101 & VIRTIO_DEV_PART_DRV_FEATURES & Driver features, +\ref{sec:Basic Facilities of a Virtio Device / Device parts / Common +device parts / VIRTIO_DEV_PART_DRV_FEATURES} \\
\hline
-0x102 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts /

VIRTIO_DEV_PART_PCI_COMMON_CFG]{VIRTIO_DEV_PART_PCI_COMMON_ CFG} & PCI

Quoted 2 lines

common configuration \\
+0x102 & VIRTIO_DEV_PART_PCI_COMMON_CFG & PCI common

configuration,

Quoted 6 lines
device-parts.tex +2 -1
+see \ref{sec:Basic Facilities of a Virtio Device / Device parts /
+Common device parts / VIRTIO_DEV_PART_PCI_COMMON_CFG} \\
 \hline
-0x103 & \hyperref[sec:Basic Facilities of a Virtio Device / Device

parts / Common device parts / VIRTIO_DEV_PART_DEVICE_STATUS]{VIRTIO_DEV_PART_DEVICE_STATUS}

& Device

Quoted 8 lines

status \\
+0x103 & VIRTIO_DEV_PART_DEVICE_STATUS & Device status, see +\ref{sec:Basic Facilities of a Virtio Device / Device parts / Common +device parts / VIRTIO_DEV_PART_DEVICE_STATUS} \\
\hline
-0x104 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_CFG]{VIRTIO_DEV_PART_VQ_CFG} & Virtqueue

Quoted 8 lines

configuration \\
+0x104 & VIRTIO_DEV_PART_VQ_CFG & Virtqueue configuration, see +\ref{sec:Basic Facilities of a Virtio Device / Device parts / Common +device parts / VIRTIO_DEV_PART_VQ_CFG} \\
\hline
-0x105 & \hyperref[sec:Basic Facilities of a Virtio Device / Device parts / Common device parts / VIRTIO_DEV_PART_VQ_NOTIFY_CFG]{VIRTIO_DEV_PART_VQ_NOTIFY_CFG}

&

device-parts.tex

Quoted 4 lines

Virtqueue notification configuration \\
+0x105 & VIRTIO_DEV_PART_VQ_NOTIFY_CFG & Virtqueue notification

device-parts.tex +2 -0
+configuration, see \ref{sec:Basic Facilities of a Virtio Device /
+Device parts / Common device parts /

VIRTIO_DEV_PART_VQ_NOTIFY_CFG}

Quoted 6 lines

+\\
\hline
0x106 - 0x2FF & - & Common device parts range reserved for future \\
\hline @@ -157,7 +157,8 @@ \subsubsection{VIRTIO_DEV_PART_PCI_COMMON_CFG}
One or multiple VIRTIO_DEV_PART_PCI_COMMON_CFG parts may exist in

the

Quoted 3 lines

get or set commands; each such part corresponds to a unique \field{offset}.

-

\subsubsection{VIRTIO_DEV_PART_DEVICE_STATUS}\label{par:VIRTIO_DEV_P A

Quoted 5 lines

RT_DEVICE_STATUS} +\subsubsection{VIRTIO_DEV_PART_DEVICE_STATUS} +\label{sec:Basic Facilities of a Virtio Device / Device parts / +Common device parts / VIRTIO_DEV_PART_DEVICE_STATUS}

Quoted 8 lines

For VIRTIO_DEV_PART_DEVICE_STATUS, \field{part_type} is set to 0x103. The VIRTIO_DEV_PART_DEVICE_STATUS field indicates the device status
as listed in @@ -215,7 +216,7 @@ \subsubsection{VIRTIO_DEV_PART_VQ_NOTIFY_CFG}

\field{queue_notify_off} and \field{queue_notif_config_data}
corresponds to the fields in \field{struct virtio_pci_common_cfg} described in -\hyperref[sec:Virtio Transport Options / Virtio Over PCI Bus /

PCI Device Layout / Common configuration structure layout]{Virtio PCI common configuration space}.

Quoted 1 line

+\ref{sec:Virtio Transport Options / Virtio Over PCI Bus / PCI Device Layout /

Common configuration structure layout}.

Quoted 3 lines

One or multiple instance of the device part
VIRTIO_DEV_PART_VQ_NOTIFY_CFG may exist in the get and set

commands,

Quoted 3 lines

each such device part corresponds to a unique
--
2.34.1