Re: [PATCH] editorial: replace hyperref with ref

["Michael S. Tsirkin" <mst@redhat.com>]

On Fri, Jul 12, 2024 at 01:10:35PM +0000, Parav Pandit wrote:
> 
> 
> > From: Michael S. Tsirkin <mst@redhat.com>
> > Sent: Friday, July 12, 2024 4:30 PM
> > To: Parav Pandit <pandit.parav@gmail.com>
> > Cc: virtio-comment@lists.linux.dev; cohuck@redhat.com; Parav Pandit
> > <parav@nvidia.com>
> > Subject: Re: [PATCH] editorial: replace hyperref with ref
> > 
> > On Fri, Jul 12, 2024 at 07:14:33AM +0300, Parav Pandit wrote:
> > > 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.

> Will follow in future patches.
>  
> > 
> > > Suggested-by: Michael S. Tsirkin <mst@redhat.com>
> > > Signed-off-by: Parav Pandit <parav@nvidia.com>
> > 
> > 
> > > ---
> > >  admin-cmds-device-parts.tex     |  6 +++---
> > >  admin-cmds-resource-objects.tex |  2 +-
> > >  device-parts.tex                | 19 ++++++++++---------
> > >  3 files changed, 14 insertions(+), 13 deletions(-)
> > >
> > > diff --git a/admin-cmds-device-parts.tex b/admin-cmds-device-parts.tex
> > > index ab6e83b..4aa1464 100644
> > > --- a/admin-cmds-device-parts.tex
> > > +++ b/admin-cmds-device-parts.tex
> > > @@ -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_RESO
> > URCE_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 diff --git
> > > a/admin-cmds-resource-objects.tex b/admin-cmds-resource-objects.tex
> > > index 388aa69..d0a6647 100644
> > > --- a/admin-cmds-resource-objects.tex
> > > +++ b/admin-cmds-resource-objects.tex
> > > @@ -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
> > > diff --git a/device-parts.tex b/device-parts.tex index
> > > 7384408..47ad06d 100644
> > > --- a/device-parts.tex
> > > +++ b/device-parts.tex
> > > @@ -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_P
> > A
> > > 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}
> > >
> > >  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
> > > --
> > > 2.34.1