Re: [virtio-comment] Re: [PATCH 0/4] Short document fixes to inner hash feature

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

On Thu, Jul 13, 2023 at 11:32:32AM +0200, Cornelia Huck wrote:
> On Thu, Jul 13 2023, Cornelia Huck <cohuck@redhat.com> wrote:
> 
> > On Thu, Jul 13 2023, Parav Pandit <parav@nvidia.com> wrote:
> >
> >> This short patches fixes the editing errors that stops the pdf and html
> >> generation.
> >>
> >> These 3 fixes are for the patch [1] for the github issue [2].
> >>
> >> [1] https://lists.oasis-open.org/archives/virtio-comment/202307/msg00024.html
> >> [2] https://github.com/oasis-tcs/virtio-spec/issues/173
> >>
> >> Patch summary:
> >> patch-1 place C code under listing
> >> patch-2 avoid hyphen and extra braces
> >> patch-3 use table as hyperlink do not work well in C code listing
> >> patch-4 refer 'advice' as 'note'
> >>
> >> Patch 1 to 3 appears to be must in the testing.
> >> Patch 4 is not a fix and can be done later if it requires discussion.
> >>
> >> Parav Pandit (4):
> >>   virtio-net: Place C code under listing
> >>   virtio-net: Avoid hyphen and extra braces
> >>   virtio-net: Use table to describe inner hash to rfc mapping
> >>   virtio-net: Use note instead of advice
> >>
> >>  device-types/net/description.tex | 45 ++++++++++++++++++++++----------
> >>  introduction.tex                 | 15 +++++------
> >>  2 files changed, 38 insertions(+), 22 deletions(-)
> >>
> >
> > FTR, this is the diff I have locally (I had missed one underscore in the
> > references yesterday...); maybe we can make the intra-reference links in
> > introdcution.tex a bit nicer, but otherwise, this should be the minimal
> > change to make this build:
> 
> For the "make it look nicer" part, I think this one would get the job
> done; opinions?
> 
> diff --git a/introduction.tex b/introduction.tex
> index 6f10a94b6fde..1e39a4b2c529 100644
> --- a/introduction.tex
> +++ b/introduction.tex
> @@ -106,8 +106,8 @@ \section{Normative References}\label{sec:Normative References}
>      Generic Routing Encapsulation. This protocol is only specified for IPv4 and used as either the payload or delivery protocol.
>  	\newline\url{https://datatracker.ietf.org/doc/rfc2784/}\\
>  	\phantomsection\label{intro:rfc2890}\textbf{[RFC2890]} &
> -    Key and Sequence Number Extensions to GRE \ref{intro:rfc2784}. This protocol describes extensions by which two fields, Key and
> -    Sequence Number, can be optionally carried in the GRE Header \ref{intro:rfc2784}.
> +    Key and Sequence Number Extensions to \hyperref[intro:rfc2784]{GRE}. This protocol describes extensions by which two fields, Key and
> +    Sequence Number, can be optionally carried in the \hyperref[intro:rfc2784]{GRE} Header.

This does look nicer.

>  	\newline\url{https://www.rfc-editor.org/rfc/rfc2890}\\
>  	\phantomsection\label{intro:rfc7676}\textbf{[RFC7676]} &
>      IPv6 Support for Generic Routing Encapsulation (GRE). This protocol is specified for IPv6 and used as either the payload or