[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: Re: [PATCH 0/4] Short document fixes to inner hash feature
å 2023/7/13 äå7:33, Michael S. Tsirkin åé:
On Thu, Jul 13, 2023 at 11:12:13AM +0200, Cornelia Huck 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:Perfect. Seems like clearly an editorial fix. Heng Qi, in the future I'd like to ask you to please build the spec and review the resulting PDF and HTML, before posting.
Yes, I will!
diff --git a/device-types/net/description.tex b/device-types/net/description.tex index 206020de567d..76585b0dd6d3 100644 --- a/device-types/net/description.tex +++ b/device-types/net/description.tex @@ -1024,12 +1024,14 @@ \subsubsection{Processing of Incoming Packets}\label{sec:Device Types / Network If VIRTIO_NET_F_HASH_TUNNEL has been negotiated, the driver can send the command VIRTIO_NET_CTRL_HASH_TUNNEL_SET to configure the calculation of the inner header hash.+\begin{lstlisting}struct virtnet_hash_tunnel { le32 enabled_tunnel_types; };#define VIRTIO_NET_CTRL_HASH_TUNNEL 7#define VIRTIO_NET_CTRL_HASH_TUNNEL_SET 0 +\end{lstlisting}Field \field{enabled_tunnel_types} contains the bitmask of encapsulation types enabled for inner header hash.See \ref{sec:Device Types / Network Device / Device Operation / Processing of Incoming Packets / @@ -1063,16 +1065,16 @@ \subsubsection{Processing of Incoming Packets}\label{sec:Device Types / Network Hash calculation for incoming packets / Encapsulation types supported/enabled for inner header hash}Encapsulation types applicable for inner header hash:-\begin{lstlisting} -#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_2784 (1 << 0) /* \hyperref[intro:gre_rfc2784]{[GRE_rfc2784]} */ -#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_2890 (1 << 1) /* \hyperref[intro:gre_rfc2890]{[GRE_rfc2890]} */ -#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_7676 (1 << 2) /* \hyperref[intro:gre_rfc7676]{[GRE_rfc7676]} */ -#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_UDP (1 << 3) /* \hyperref[intro:gre_in_udp_rfc8086]{[GRE-in-UDP]} */ -#define VIRTIO_NET_HASH_TUNNEL_TYPE_VXLAN (1 << 4) /* \hyperref[intro:vxlan]{[VXLAN]} */ -#define VIRTIO_NET_HASH_TUNNEL_TYPE_VXLAN_GPE (1 << 5) /* \hyperref[intro:vxlan_gpe]{[VXLAN-GPE]} */ -#define VIRTIO_NET_HASH_TUNNEL_TYPE_GENEVE (1 << 6) /* \hyperref[intro:geneve]{[GENEVE]} */ -#define VIRTIO_NET_HASH_TUNNEL_TYPE_IPIP (1 << 7) /* \hyperref[intro:ipip]{[IPIP]} */ -#define VIRTIO_NET_HASH_TUNNEL_TYPE_NVGRE (1 << 8) /* \hyperref[intro:nvgre]{[NVGRE]} */ +\begin{lstlisting}[escapechar=|] +#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_2784 (1 << 0) /* |\hyperref[intro:rfc2784]{[RFC2784]}| */ +#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_2890 (1 << 1) /* |\hyperref[intro:rfc2890]{[RFC2890]}| */ +#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_7676 (1 << 2) /* |\hyperref[intro:rfc7676]{[RFC7676]}| */ +#define VIRTIO_NET_HASH_TUNNEL_TYPE_GRE_UDP (1 << 3) /* |\hyperref[intro:rfc8086]{[GRE-in-UDP]}| */ +#define VIRTIO_NET_HASH_TUNNEL_TYPE_VXLAN (1 << 4) /* |\hyperref[intro:vxlan]{[VXLAN]}| */ +#define VIRTIO_NET_HASH_TUNNEL_TYPE_VXLAN_GPE (1 << 5) /* |\hyperref[intro:vxlan-gpe]{[VXLAN-GPE]}| */ +#define VIRTIO_NET_HASH_TUNNEL_TYPE_GENEVE (1 << 6) /* |\hyperref[intro:geneve]{[GENEVE]}| */ +#define VIRTIO_NET_HASH_TUNNEL_TYPE_IPIP (1 << 7) /* |\hyperref[intro:ipip]{[IPIP]}| */ +#define VIRTIO_NET_HASH_TUNNEL_TYPE_NVGRE (1 << 8) /* |\hyperref[intro:nvgre]{[NVGRE]}| */ \end{lstlisting}\subparagraph{Advice}diff --git a/introduction.tex b/introduction.tex index 81f07a4fee19..6f10a94b6fde 100644 --- a/introduction.tex +++ b/introduction.tex @@ -102,18 +102,18 @@ \section{Normative References}\label{sec:Normative References} Standards for Efficient Cryptography Group(SECG), ``SEC1: Elliptic Cureve Cryptography'', Version 1.0, September 2000. \newline\url{https://www.secg.org/sec1-v2.pdf}\\- \phantomsection\label{intro:gre_rfc2784}\textbf{[GRE_rfc2784]} &+ \phantomsection\label{intro:rfc2784}\textbf{[RFC2784]} & 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:gre_rfc2890}\textbf{[GRE_rfc2890]} & - Key and Sequence Number Extensions to GRE \ref{intro:gre_rfc2784}. This protocol describes extensions by which two fields, Key and - Sequence Number, can be optionally carried in the GRE Header \ref{intro:gre_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}. \newline\url{https://www.rfc-editor.org/rfc/rfc2890}\\ - \phantomsection\label{intro:gre_rfc7676}\textbf{[GRE_rfc7676]} & + \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 delivery protocol. Note that this does not change the GRE header format or any behaviors specified by RFC 2784 or RFC 2890. \newline\url{https://datatracker.ietf.org/doc/rfc7676/}\\ - \phantomsection\label{intro:gre_in_udp_rfc8086}\textbf{[GRE-in-UDP]} & + \phantomsection\label{intro:rfc8086}\textbf{[GRE-in-UDP]} & GRE-in-UDP Encapsulation. This specifies a method of encapsulating network protocol packets within GRE and UDP headers. This protocol is specified for IPv4 and IPv6, and used as either the payload or delivery protocol. \newline\url{https://www.rfc-editor.org/rfc/rfc8086}\\
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]