|WARNING| pw152698 [PATCH] doc: reword flow offload and api docs

|WARNING| pw152698 [PATCH] doc: reword flow offload and api docs

[qemudev]

Test-Label: loongarch-compilation
Test-Status: WARNING
http://dpdk.org/patch/152698

_apply patch failure_

Submitter: Nandini Persad <nandinipersad361@gmail.com>
Date: Mon, 31 Mar 2025 14:40:36 -0700
DPDK git baseline: Repo:dpdk-next-net
  Branch: main
  CommitID: f3cb237103aada7bc83fd3f40929fb6fb3e58c3b

Apply patch set 152698 failed:

Checking patch doc/guides/prog_guide/ethdev/flow_offload.rst...
error: while searching for:
(Ethernet) and L4 (UDP). Doing so is only allowed at the bottom and at the
top of the stack.

Meta item types
~~~~~~~~~~~~~~~

They match meta-data or affect pattern processing instead of matching packet
data directly, most of them do not need a specification structure. This
particularity allows them to be specified anywhere in the stack without
causing any side effect.

Item: ``END``
^^^^^^^^^^^^^

End marker for item lists. Prevents further processing of items, thereby
ending the pattern.

- Its numeric value is 0 for convenience.
- PMD support is mandatory.
- ``spec``, ``last`` and ``mask`` are ignored.

. _table_rte_flow_item_end:

. table:: END

   +----------+---------+
   | Field    | Value   |
   +==========+=========+
   | ``spec`` | ignored |
   +----------+---------+
   | ``last`` | ignored |
   +----------+---------+
   | ``mask`` | ignored |
   +----------+---------+

Item: ``VOID``
^^^^^^^^^^^^^^

Used as a placeholder for convenience. It is ignored and simply discarded by
PMDs.

- PMD support is mandatory.
- ``spec``, ``last`` and ``mask`` are ignored.

. _table_rte_flow_item_void:

. table:: VOID

   +----------+---------+
   | Field    | Value   |
   +==========+=========+
   | ``spec`` | ignored |
   +----------+---------+
   | ``last`` | ignored |
   +----------+---------+
   | ``mask`` | ignored |
   +----------+---------+

One usage example for this type is generating rules that share a common
prefix quickly without reallocating memory, only by updating item types:

. _table_rte_flow_item_void_example:

. table:: TCP, UDP or ICMP as L4

   +-------+--------------------+
   | Index | Item               |
   +=======+====================+
   | 0     | Ethernet           |
   +-------+--------------------+
   | 1     | IPv4               |
   +-------+------+------+------+
   | 2     | UDP  | VOID | VOID |
   +-------+------+------+------+
   | 3     | VOID | TCP  | VOID |
   +-------+------+------+------+
   | 4     | VOID | VOID | ICMP |
   +-------+------+------+------+
   | 5     | END                |
   +-------+--------------------+

Item: ``INVERT``
^^^^^^^^^^^^^^^^

Inverted matching, i.e. process packets that do not match the pattern.

- ``spec``, ``last`` and ``mask`` are ignored.

. _table_rte_flow_item_invert:

. table:: INVERT

   +----------+---------+
   | Field    | Value   |
   +==========+=========+
   | ``spec`` | ignored |
   +----------+---------+
   | ``last`` | ignored |
   +----------+---------+
   | ``mask`` | ignored |
   +----------+---------+

Usage example, matching non-TCPv4 packets only:

. _table_rte_flow_item_invert_example:

. table:: Anything but TCPv4

   +-------+----------+
   | Index | Item     |
   +=======+==========+
   | 0     | INVERT   |
   +-------+----------+
   | 1     | Ethernet |
   +-------+----------+
   | 2     | IPv4     |
   +-------+----------+
   | 3     | TCP      |
   +-------+----------+
   | 4     | END      |
   +-------+----------+

Item: ``PORT_ID``
^^^^^^^^^^^^^^^^^

This item is deprecated. Consider:
 - `Item: PORT_REPRESENTOR`_
 - `Item: REPRESENTED_PORT`_

Matches traffic originating from (ingress) or going to (egress) a given DPDK
port ID.

Normally only supported if the port ID in question is known by the
underlying PMD and related to the device the flow rule is created against.

- Default ``mask`` matches the specified DPDK port ID.

. _table_rte_flow_item_port_id:

. table:: PORT_ID

   +----------+----------+-----------------------------+
   | Field    | Subfield | Value                       |
   +==========+==========+=============================+
   | ``spec`` | ``id``   | DPDK port ID                |
   +----------+----------+-----------------------------+
   | ``last`` | ``id``   | upper range value           |
   +----------+----------+-----------------------------+
   | ``mask`` | ``id``   | zeroed to match any port ID |
   +----------+----------+-----------------------------+

Item: ``MARK``
^^^^^^^^^^^^^^

Matches an arbitrary integer value which was set using the ``MARK`` action
error: patch failed: doc/guides/prog_guide/ethdev/flow_offload.rst:412
error: doc/guides/prog_guide/ethdev/flow_offload.rst: patch does not apply
Checking patch lib/ethdev/rte_flow.h...

|WARNING| pw152698 [PATCH] doc: reword flow offload and api docs

[checkpatch]

Test-Label: checkpatch
Test-Status: WARNING
http://dpdk.org/patch/152698

_coding style issues_


WARNING:TYPO_SPELLING: 'wih' may be misspelled - perhaps 'with'?
#3558: FILE: doc/guides/prog_guide/ethdev/flow_offload.rst:579:
+- Flush: The function ``rte_flow_flush`` destroys all flow rules associated wih a port.

WARNING:TYPO_SPELLING: 'behvaior' may be misspelled - perhaps 'behaviour'?
#4142: FILE: lib/ethdev/rte_flow.h:4403:
+ * is missing at the specified index, then the behvaior is undefined and

total: 0 errors, 2 warnings, 4087 lines checked

|WARNING| pw152698 [PATCH] doc: reword flow offload and api docs

[dpdklab]

Test-Label: iol-testing
Test-Status: WARNING
http://dpdk.org/patch/152698

_apply patch failure_

Submitter: Nandini Persad <nandinipersad361@gmail.com>
Date: Monday, March 31 2025 21:40:36 
Applied on: CommitID:edd3f4b1265e6da707c46ca9b6c39d332647baea
Apply patch set 152698 failed:

Cloning the DPDK mirror at: https://github.com/DPDK/dpdk.git (Attempt 1 of 3)
Trying to checkout branch: origin/main
Checked out to main (edd3f4b1265e6da707c46ca9b6c39d332647baea)
Done: main commit edd3f4b1265e6da707c46ca9b6c39d332647baea
Trying to checkout branch: origin/next-net-for-main
Checked out to next-net-for-main (f3cb237103aada7bc83fd3f40929fb6fb3e58c3b)
Applying patch...

Failed to apply patch:
Applying: doc: reword flow offload and api docs
Using index info to reconstruct a base tree...
M	doc/guides/prog_guide/ethdev/flow_offload.rst
Falling back to patching base and 3-way merge...
Auto-merging doc/guides/prog_guide/ethdev/flow_offload.rst
CONFLICT (content): Merge conflict in doc/guides/prog_guide/ethdev/flow_offload.rst
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 doc: reword flow offload and api docs
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".


Trying to checkout branch: origin/main
Checked out to main (edd3f4b1265e6da707c46ca9b6c39d332647baea)
Applying patch...

Failed to apply patch:
Applying: doc: reword flow offload and api docs
Using index info to reconstruct a base tree...
M	doc/guides/prog_guide/ethdev/flow_offload.rst
Falling back to patching base and 3-way merge...
Auto-merging doc/guides/prog_guide/ethdev/flow_offload.rst
CONFLICT (content): Merge conflict in doc/guides/prog_guide/ethdev/flow_offload.rst
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 doc: reword flow offload and api docs
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".


https://lab.dpdk.org/results/dashboard/patchsets/32916/

UNH-IOL DPDK Community Lab