Skip to contentSkip to conversation

doc: fix typo in coding style

PATCH Applied Dariusz Sosnowski 3 participants 3 messages Oct 29, 2021 – Nov 26, 2021

lore
Share & tools
lore

Dariusz Sosnowski

author
#0 lore raw

PATCH 1/1 doc: fix typo in coding style

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

Fixes 36032e46be40 ("doc: add coding style")
Cc [email protected]
Signed-off-by Dariusz Sosnowski <[email protected]>
---
 doc/guides/contributing/coding_style.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/guides/contributing/coding_style.rst +1 -1
index b27b5fcfdb..506f706ebd 100644
@@ -619,7 +619,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.
Signature · 1 line
2.25.1