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

[Thomas Monjalon <thomas@monjalon.net>]

24/10/2025 15:30, Serhii Iliushyk:
> From: Thomas Monjalon <thomas@monjalon.net>
> >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?

No value, but keep it narrow to allow adding columns without going out of space.

Descriptions should got somewhere else, not in a table.

Look how links are used in mlx5 doc tables.


> >[...]
> >> +<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.

Yes, it is not a sentence.
 
> >[...]
> >> -``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.

HTML output should be the priority.

> >[...]
> >>  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

OK

> >[...]
> >> -.. note::
> >> +   .. note::
> > 
> >No reason to do that.
>  
> If there is no tabulation, the section "None" grabs all the text below in the HTML.

So the problem is opposite, you must unindent the text below, right?