diff mbox

[dpdk-dev,1/2] doc: Clarify wording regarding actions and flow rules.

Message ID 20171201182640.21885-1-roy.franz@cavium.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Roy Franz Dec. 1, 2017, 6:26 p.m. UTC 
  Current wording regarding actions and flow rules doesn't make sense.

Signed-off-by: Roy Franz <roy.franz@cavium.com>
---
Maybe a better word than 'assigned' could be chosen?  (attached,
 associated with, etc)  I'm happy to spin this if needed.


 doc/guides/prog_guide/rte_flow.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Adrien Mazarguil Dec. 4, 2017, 1:51 p.m. UTC | #1 
On Fri, Dec 01, 2017 at 10:26:39AM -0800, Roy Franz wrote:
> Current wording regarding actions and flow rules doesn't make sense.
> 
> Signed-off-by: Roy Franz <roy.franz@cavium.com>
> ---
> Maybe a better word than 'assigned' could be chosen?  (attached,
>  associated with, etc)  I'm happy to spin this if needed.

Agreed, "affected" doesn't make much sense here. I think "assigned" is the
best compromise (intelligibility / changes ratio).

This clarification is also a worthy candidate for stable@dpdk.org.

Acked-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>
diff mbox

Patch

diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst
index d158be5e4..9de6d32d3 100644
--- a/doc/guides/prog_guide/rte_flow.rst
+++ b/doc/guides/prog_guide/rte_flow.rst
@@ -984,7 +984,7 @@  Actions
 ~~~~~~~
 
 Each possible action is represented by a type. Some have associated
-configuration structures. Several actions combined in a list can be affected
+configuration structures. Several actions combined in a list can be assigned
 to a flow rule. That list is not ordered.
 
 They fall in three categories: