From: Thomas Monjalon <[email protected]>
Sent: 23 October 2025 17:49
To: Serhii Iliushyk <[email protected]>
Cc: [email protected] <[email protected]>; Mykola Kostenok <[email protected]>; Serhii
Iliushyk <[email protected]>; Christian Koue Muf <[email protected]>;
[email protected] <[email protected]>
Subject: Re: [PATCH v2] doc: refactoring the guide for NTNIC PMD
>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.
I will fix it. Is there any value for column length?
>
>[...]
>> +<object>.<attribute>=[<object-ids>:]<value>
>
>Should it have a fixed witdth font?
>
It may have a fixed-width font. I can fix it if it's required.
>
>[...]
>> -``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?
>
I did it to make it clearer when viewing the doc in RST preview or in plain
text.
>
>[...]
>> Logging and Debugging
>> ----------------------
>> +~~~~~~~~~~~~~~~~~~~~~
>
>Why? So there is only 1 main title like "Features"?
>
The titles have further structure after refactoring:
NTNIC Poll Mode Driver
- Design
- Supported NICs
- Features
- Limitations
- Configuration
- Command line arguments
- Logging and Debugging
- Flow Scanner
- Service API
- Service API for user applications
>
>[...]
>> -.. note::
>> + .. note::
>
>No reason to do that.
If there is no tabulation, the section "None" grabs all the text below in the
HTML.
