Re: [PATCH] device-parts: editorial: Fix metadata type name

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

On Tue, Sep 10, 2024 at 04:46:34PM +0000, Parav Pandit wrote:
> 
> 
> > From: Matias Ezequiel Vara Larsen <mvaralar@redhat.com>
> > Sent: Monday, September 9, 2024 7:48 PM
> > 
> > On Sat, Sep 07, 2024 at 07:52:18PM +0300, Parav Pandit wrote:
> > > The description is for the type
> > > VIRTIO_ADMIN_CMD_DEV_PARTS_METADATA_TYPE_LIST;
> > > however, it referred to a non-existent definition. Correct it.
> > >
> > > Branch: virtio-1.4
> > > Fixes: aa4f6f069ab3 ("admin: Add admin commands for device parts")
> > > Signed-off-by: Parav Pandit <parav@nvidia.com>
> > > ---
> > >  admin-cmds-device-parts.tex | 4 ++--
> > >  1 file changed, 2 insertions(+), 2 deletions(-)
> > >
> > > diff --git a/admin-cmds-device-parts.tex b/admin-cmds-device-parts.tex
> > > index 27d8251..3a16692 100644
> > > --- a/admin-cmds-device-parts.tex
> > > +++ b/admin-cmds-device-parts.tex
> > > @@ -152,10 +152,10 @@ \subsubsection{Device parts}\label{sec:Basic
> > > Facilities of a Virtio Device / Dev  device responds with
> > > \field{hdr_list_count.count}. The  \field{hdr_list_count.count}
> > > indicates an count of  \field{struct virtio_dev_part_hdr} metadata
> > > entries that the device can -provide when the \field{type} is set to
> > > VIRTIO_ADMIN_CMD_DEV_PARTS_METADATA_TYPE_HDR
> > > +provide when the \field{type} is set to
> > > +VIRTIO_ADMIN_CMD_DEV_PARTS_METADATA_TYPE_LIST
> > >  in a subsequent VIRTIO_ADMIN_CMD_DEV_PARTS_METADATA_GET
> > command.
> > >
> > > -When \field{type} is set to
> > > VIRTIO_ADMIN_CMD_DEV_PARTS_METADATA_TYPE_HDR,
> > > +When \field{type} is set to
> > > +VIRTIO_ADMIN_CMD_DEV_PARTS_METADATA_TYPE_LIST,
> > >  the device responds with \field{hdr_list}. \field{hdr_list}
> > > indicates the device parts metadata.
> > >
> > > --
> > > 2.34.1
> > >
> > >
> > In previous patches, I see the pattern `\field{type} field`. I wonder if you
> > would like to do the same here for consistency but I do not have a strong
> > opinion about this. Otherwise,
> > 
> True, maybe I can remove 'field' word from some places in general language improvement separate patch.
> Will look.


It just typesets it as italic ATM. Worth doing to avoid confusion, as some
fields are plain english words.


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