[PATCH v2] doc: refactoring the guide for NTNIC PMD

[Thomas Monjalon]

23/10/2025 16:35, Serhii Iliushyk:
> +=========================================================================================== =======
> +Supported Features                                                                           Linux
> +=========================================================================================== =======
> +FW version                                                                                     X
> +Speed capabilities                                                                             X
> +Link status (Link update only)                                                                 X
> +Unicast MAC filter                                                                             X
> +Multicast MAC filter                                                                           X
> +Promiscuous mode (Enable only. The device always run promiscuous mode)                         X
> +Flow API support.                                                                              X
> +Support for multiple rte_flow groups.                                                          X
> +Multiple TX and RX queues.                                                                     X
> +Scattered and gather for TX and RX.                                                            X
> +Jumbo frame support.                                                                           X
> +Traffic mirroring.                                                                             X
> +VLAN filtering.                                                                                X
> +Packet modification: NAT, TTL decrement, DSCP tagging                                          X
> +Tunnel types: GTP.                                                                             X
> +Encapsulation and decapsulation of GTP data.                                                   X
> +RX VLAN stripping via raw decap.                                                               X
> +TX VLAN insertion via raw encap.                                                               X
> +CAM and TCAM based matching.                                                                   X
> +Exact match of 140 million flows and policies.                                                 X
> +Tunnel HW offload: Packet type, inner/outer RSS, IP and UDP checksum verification.             X
> +RSS hash                                                                                       X
> +RSS key update                                                                                 X
> +RSS based on VLAN or 5*tuple.                                                                  X
> +RSS using combinations of fields: L3 only, L4 only or both, and src only, dst only or both.    X

When you make a table, you should not write sentences.
Columns must not be wide.


[...]
> +<object>.<attribute>=[<object-ids>:]<value>

Should it have a fixed witdth font?


[...]
> -``exception_path`` parameter [int]
> +- ``exception_path`` parameter [int]

Why do you replace the definition list with a simple list?
Did you check the HTML output?


[...]
>  Logging and Debugging
> ----------------------
> +~~~~~~~~~~~~~~~~~~~~~

Why? So there is only 1 main title like "Features"?


[...]
> -.. note::
> +   .. note::

No reason to do that.