Skip to content

Commit

Permalink
doc: fix typo in coding style
Browse files Browse the repository at this point in the history
[ upstream commit 6965091 ]

This patch fixes a typo in DPDK Coding Style, in Return Values section,
i.e. replaces "indicated may" with "indicated by".

Fixes: 36032e4 ("doc: add coding style")

Signed-off-by: Dariusz Sosnowski <dsosnowski@nvidia.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
  • Loading branch information
sodar authored and cpaelzer committed Nov 30, 2021
1 parent d544d3a commit c06b4e4
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/guides/contributing/coding_style.rst
Expand Up @@ -591,7 +591,7 @@ Return Value
~~~~~~~~~~~~

* Functions which create objects, or allocate memory, should return pointer types, and NULL on error.
The error type should be indicated may setting the variable ``rte_errno`` appropriately.
The error type should be indicated by setting the variable ``rte_errno`` appropriately.
* Functions which work on bursts of packets, such as RX-like or TX-like functions, should return the number of packets handled.
* Other functions returning int should generally behave like system calls:
returning 0 on success and -1 on error, setting ``rte_errno`` to indicate the specific type of error.
Expand Down

0 comments on commit c06b4e4

Please sign in to comment.