[PATCH v2 1/1] doc/ice: document protocol agnostic filtering

[Burakov, Anatoly]

On 11/12/2025 6:04 PM, Bruce Richardson wrote:
> On Wed, Nov 12, 2025 at 11:34:12AM +0000, Anatoly Burakov wrote:
>> Current documentation for protocol agnostic filtering for ICE driver is a
>> bit terse and relies on a lot of assumed knowledge. Document the feature
>> better and make all of the assumptions explicit.
>>
>> Signed-off-by: Anatoly Burakov <anatoly.burakov at intel.com>
>> Acked-by: Vladimir Medvedkin <vladimir.medvedkin at intel.com>
>> ---


>> +
>> +.. code-block:: console
>> +
>> +   python3 flow_parse.py --show -p "mac()/ipv4(src=1.1.1.1,dst=2.2.2.2)/udp()"
>> +
>> +Output:
>> +
>> +   {'flow': {'generic': {'pattern': {'spec': b'00000000000100000000000208004500001c000000000011000001010101020202020000000000080000',
>> +   'mask': b'0000000000000000000000000000000000000000000000000000ffffffffffffffff0000000000000000'}}}}
>> +
> 
> This looks like it should have a code-block tag on it too. Was that a
> deliberate omission? If it should be there, I'll add it on apply.
> 

<snip>

>> +
>> +Spec (packet template):
>> +  000000000001              Destination MAC (6 bytes)
>> +  000000000002              Source MAC (6 bytes)
>> +  0800                      EtherType = IPv4
>> +  4500001c0000000000110000  IPv4 header, protocol = UDP
>> +  01010101                  Source IP = 1.1.1.1
>> +  02020202                  Destination IP = 2.2.2.2
>> +  0000000000080000          UDP header
>> +
> 
> The format of the output in the HTML here is not as above. Again, should
> this have a code-block tag on it?

Yes on both, they were meant to be monospace formatted (not necessarily 
a *code* block but a monospaced block at least).

> 
>> +Mask:
>> +  000000000000              Destination MAC (ignored)
>> +  000000000000              Source MAC (ignored)
>> +  0000                      EtherType (ignored)
>> +  000000000000000000000000  IPv4/UDP header (ignored)
>> +  ffffffff                  Source IP (match all 32 bits)
>> +  ffffffff                  Destination IP (match all 32 bits)
>> +  0000000000000000          UDP header (ignored)
>> +
> <snip>


-- 
Thanks,
Anatoly