On Sat, Nov 14, 2026 at 08:46:17AM +0000, Sandeep Penigalapati wrote:
> Correct several errors in the i40e guide:
> 
> - use the full "Malicious Driver Detection" feature name.
> - correct the queue region device argument description ("serves for"
>   wording, the "off" entry formatting, and the "commits"/"cleans"/
>   "restores" grammar).
> - describe "set vf allmulti" as all-multicast mode instead of the
>   copy-pasted promiscuous-mode description.
> - minor grammar and spacing fixes.
> 
> Fixes: 04c8542f96f7 ("net/i40e: set TC strict priority mode")
> Fixes: 0982ef81a665 ("doc: add DDP in i40e guide")
> Fixes: 9accffad6593 ("net/i40e: add PF MDD event handler")
> Fixes: 94b3c1a72507 ("net/i40e: move testpmd commands")
> Cc: [email protected]
> 
> Signed-off-by: Sandeep Penigalapati <[email protected]>
> ---
>  doc/guides/nics/i40e.rst | 20 ++++++++++----------
>  1 file changed, 10 insertions(+), 10 deletions(-)
> 
Acked-by: Bruce Richardson <[email protected]>

See comment inline below.

> diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
> index 29234dbf0f..1df006333b 100644
> --- a/doc/guides/nics/i40e.rst
> +++ b/doc/guides/nics/i40e.rst
> @@ -43,7 +43,7 @@ Features of the i40e PMD are:
>  - Dynamic Device Personalization (DDP)
>  - Queue region configuration
>  - Virtual Function Port Representors
> -- Malicious Device Drive event catch and notify
> +- Malicious Driver Detection event catch and notify
>  - Generic flow API
>  
>  Linux Prerequisites
> @@ -537,7 +537,7 @@ Display information about a GTP profile:
>  
>  Input set configuration
>  ~~~~~~~~~~~~~~~~~~~~~~~
> -Input set for any PCTYPE can be configured with user defined configuration,
> +Input set for any PCTYPE can be configured with user defined configuration.
>  For example, to use only 48bit prefix for IPv6 src address for IPv6 TCP RSS:
>  
>  .. code-block:: console
> @@ -669,7 +669,7 @@ If a TC is set to strict priority mode, it can consume 
> unlimited bandwidth.
>  It means if APP has set the max bandwidth for that TC, it comes to no
>  effect.
>  It's suggested to set the strict priority mode for a TC that is latency
> -sensitive but no consuming much bandwidth.
> +sensitive but not consuming much bandwidth.
>  
>  DCB function
>  ~~~~~~~~~~~~
> @@ -721,7 +721,7 @@ Set flowtype mapping on a RSS queue region on a port::
>  
>  where:
>  
> -* For the flowtype(pctype) of packet,the specific index for each type has
> +* For the flowtype(pctype) of packet, the specific index for each type has
>    been defined in file i40e_type.h as enum i40e_filter_pctype.
>  
>  Set user priority mapping on a RSS queue region on a port::
> @@ -734,13 +734,13 @@ Flush all queue region related configuration on a port::
>  
>  where:
>  
> -* ``on``: is just an enable function which server for other configuration,
> +* ``on``: is just an enable function which serves for other configuration,
>    it is for all configuration about queue region from up layer,
>    at first will only keep in DPDK software stored in driver,
> -  only after "flush on", it commit all configuration to HW.
> +  only after "flush on", it commits all configuration to HW.
>  
> -* ``"off``: is just clean all configuration about queue region just now,
> -  and restore all to DPDK i40e driver default config when start up.
> +* ``off``: cleans all configuration about queue region just now,
> +  and restores all to DPDK i40e driver default config when start up.
>  

AI review points out that these bullets are a little confusing, especially
the "on" one. Suggests the following replacements.

* ``on``: applies all pending queue region configuration to the hardware.
  The queue region commands above only store their configuration in the driver,
  and none of it takes effect until this command is run.

* ``off``: discards all queue region configuration,
  and restores the hardware to the driver default of a single region spanning 
all queues.

If these edits are ok, will change on apply.

>  Show all queue region related configuration info on a port::
>  
> @@ -765,7 +765,7 @@ set allmulticast (for VF)
>  
>  Set the multicast promiscuous mode for a VF from PF.
>  It's supported by Intel i40e NICs now.
> -In promiscuous mode packets are not dropped if they aren't for the specified 
> MAC address::
> +In all-multicast mode all multicast packets are received regardless of the 
> multicast address filter::
>  
>     testpmd> set vf allmulti (port_id) (vf_id) (on|off)
>  
> @@ -858,7 +858,7 @@ where:
>  
>  * ``target``: A specific software ptype or a mask to represent a group of 
> software ptypes.
>  
> -* ``mask``: A flag indicate if "target" is a specific software ptype(=0) or 
> a ptype mask(=1).
> +* ``mask``: A flag indicates if "target" is a specific software ptype(=0) or 
> a ptype mask(=1).
>  
>  * ``pkt_type``: The new software ptype to replace the old ones.
>  
> -- 
> 2.34.1
> 

Reply via email to