From: Heng Qi <hengqi@linux.alibaba.com>
To: "Michael S. Tsirkin" <mst@redhat.com>, Cornelia Huck <cohuck@redhat.com>
Cc: Parav Pandit <parav@nvidia.com>,
virtio-comment@lists.oasis-open.org,
virtio-dev@lists.oasis-open.org, shahafs@nvidia.com
Subject: [virtio-dev] Re: [PATCH 0/4] Short document fixes to inner hash feature
Date: Thu, 13 Jul 2023 19:58:53 +0800 [thread overview]
Message-ID: <e8222b54-9229-a9e7-6d34-8a47791228d8@linux.alibaba.com> (raw)
In-Reply-To: <20230713073051-mutt-send-email-mst@kernel.org>
在 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}\\
---------------------------------------------------------------------
To unsubscribe, e-mail: virtio-dev-unsubscribe@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-help@lists.oasis-open.org
prev parent reply other threads:[~2023-07-13 11:59 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-07-12 22:24 [virtio-dev] [PATCH 0/4] Short document fixes to inner hash feature Parav Pandit
2023-07-12 22:24 ` [virtio-dev] [PATCH 1/4] virtio-net: Place C code under listing Parav Pandit
2023-07-13 9:13 ` [virtio-dev] Re: [virtio-comment] " Cornelia Huck
2023-07-13 11:44 ` [virtio-dev] " Parav Pandit
2023-07-12 22:24 ` [virtio-dev] [PATCH 2/4] virtio-net: Avoid hyphen and extra braces Parav Pandit
2023-07-13 9:16 ` [virtio-dev] " Cornelia Huck
2023-07-12 22:24 ` [virtio-dev] [PATCH 3/4] virtio-net: Use table to describe inner hash to rfc mapping Parav Pandit
2023-07-12 22:41 ` [virtio-dev] " Michael S. Tsirkin
2023-07-12 22:42 ` [virtio-dev] " Parav Pandit
2023-07-13 8:09 ` Cornelia Huck
2023-07-13 11:01 ` [virtio-dev] " Michael S. Tsirkin
2023-07-12 22:24 ` [virtio-dev] [PATCH 4/4] virtio-net: Use note instead of advice Parav Pandit
2023-07-13 9:12 ` [virtio-dev] Re: [PATCH 0/4] Short document fixes to inner hash feature Cornelia Huck
2023-07-13 9:32 ` [virtio-dev] Re: [virtio-comment] " Cornelia Huck
2023-07-13 11:00 ` Michael S. Tsirkin
2023-07-13 11:33 ` [virtio-dev] " Michael S. Tsirkin
2023-07-13 11:58 ` Heng Qi [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=e8222b54-9229-a9e7-6d34-8a47791228d8@linux.alibaba.com \
--to=hengqi@linux.alibaba.com \
--cc=cohuck@redhat.com \
--cc=mst@redhat.com \
--cc=parav@nvidia.com \
--cc=shahafs@nvidia.com \
--cc=virtio-comment@lists.oasis-open.org \
--cc=virtio-dev@lists.oasis-open.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).