From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 6D2327EF09 for ; Fri, 12 Jul 2024 10:52:15 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=170.10.133.124 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720781537; cv=none; b=M1AfqrFLqZ/xYHRAE7UJ/2XyA8nd623Ogul7+N7xm7UG3uzGXH+Ynv33+P5Z0I7XNz3di5egCldgcMBn/cvAvA2gX0QI6THa1FNXtJB2xCvn9/aRJjPPAXp3LEKR6zAwYJZKb3RoGqMqikkLZweBdqnwPz3oClxqsNVp5IjwvCM= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720781537; c=relaxed/simple; bh=EKmwr/UMS5QedKhjGZbUpnrCo7pI1pmAR0MJNqtMc4s=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: In-Reply-To:Content-Type:Content-Disposition; b=a0ztE0YuUAKjdW2gu/kDz6apwApBxumfzMnUR6PD2fKJ8FKSiT8BLdTYkekfSDPGUUyJr97cfhZAU47a/NtVsE4vYZA2lW/jvXRXePq4HlFI6J9SKsQ7ZAJYmqKqIGBsJTvjec6kNfsmJwjB+Qk6bNzaifBdoB7UjThbKc0Oh0k= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=redhat.com; spf=pass smtp.mailfrom=redhat.com; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b=T/X83+Dk; arc=none smtp.client-ip=170.10.133.124 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=redhat.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="T/X83+Dk" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1720781534; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=J/MoYl3z8Kv/Q7XbbSqvVd2UTjRx93qO8LiVpue5Sm0=; b=T/X83+Dk0fdHjkfwaVTeZWN80+2ibIrpfPwcK/mWQwFTE5MPQLENliWYH545plKZOltNih ccZSFnQi3ckxeivSpQjjz95zWeC97LEbdkYdVNiKLokGl3zdZgrkKbCWmMOjlRMEsEQILp KEqzzujgcjqiX3PtatuWTo8EQ72Uh4c= Received: from mail-ej1-f70.google.com (mail-ej1-f70.google.com [209.85.218.70]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-198-n8fz_m1ROhSx7dFodQBHUw-1; Fri, 12 Jul 2024 06:52:12 -0400 X-MC-Unique: n8fz_m1ROhSx7dFodQBHUw-1 Received: by mail-ej1-f70.google.com with SMTP id a640c23a62f3a-a77c85826fdso167242166b.3 for ; Fri, 12 Jul 2024 03:52:12 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1720781531; x=1721386331; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=J/MoYl3z8Kv/Q7XbbSqvVd2UTjRx93qO8LiVpue5Sm0=; b=bK5Embk5VSYXRd/H/eznNEBzR22V9FpxexhgfXwTGlHqpvwMClOiZatzMTj7QGw7A6 oAr9gaRFLjjlBIXxOqz0hrhDsO3VjYGrVYCEUySt1mpkJMw1eXBQ+qLwN6mPVgMEf0gI tQ45FiP0gAQQKPPVy64BKJTnT1TXNuespC6YeZaztv2J4OHO/5LI+jb+xXbH+ND5/ZoX ssScbD5I26SP3o2q6Z4lR98SEs3FVN8UZ0qPvJfOghcYe5UX2g+x5vApQNu82PM/27Zx 2Glx636+PT0aDtodm1vaoRyFFW/dS8up0Gsp2Y8+WzmpaVc33KMgVsSW3ayHaXNjWwqm vgFQ== X-Gm-Message-State: AOJu0Yw5mS4txSo8jFdNTem4klK9HrTizZPX2djo59/CdX3gJO16F2QI 1mlDJcJrROo5R1swDEtF3IlnUgm9y9wymTChpq0BlUT8+RhtcbtxCso621GgN4iDe4i3PnuW/Ed XAg8ccl+dFmQq3PUCUpdxQRZfbajeWGYTBsD9QBoEZH6RQWhAmZQf3sYgjSTbn6uD X-Received: by 2002:a17:907:b9cc:b0:a77:f5ca:f835 with SMTP id a640c23a62f3a-a780b6b0d8cmr701354966b.18.1720781531645; Fri, 12 Jul 2024 03:52:11 -0700 (PDT) X-Google-Smtp-Source: AGHT+IG9JWkr7mF/U1DOssAQcdKINBhclQyrUsxQbaRC1pyNo99f7iVZtU5kmYUvEfNG9eTJ3qz+WQ== X-Received: by 2002:a17:907:b9cc:b0:a77:f5ca:f835 with SMTP id a640c23a62f3a-a780b6b0d8cmr701353366b.18.1720781530991; Fri, 12 Jul 2024 03:52:10 -0700 (PDT) Received: from redhat.com ([2a0d:6fc7:341:761e:f82:fc9a:623b:3fd1]) by smtp.gmail.com with ESMTPSA id a640c23a62f3a-a79834624c6sm204015966b.201.2024.07.12.03.52.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 12 Jul 2024 03:52:10 -0700 (PDT) Date: Fri, 12 Jul 2024 06:52:02 -0400 From: "Michael S. Tsirkin" To: Parav Pandit Cc: virtio-comment@lists.linux.dev, cohuck@redhat.com, Parav Pandit Subject: Re: [PATCH] editorial: replace hyperref with ref Message-ID: <20240712064951-mutt-send-email-mst@kernel.org> References: <20240712041433.3246718-1-parav@nvidia.com> Precedence: bulk X-Mailing-List: virtio-comment@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 In-Reply-To: <20240712041433.3246718-1-parav@nvidia.com> X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset=us-ascii Content-Disposition: inline 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. typo > > Suggested-by: Michael S. Tsirkin > Signed-off-by: Parav Pandit > --- > 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_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}. 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. > > 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_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 > -- > 2.34.1