diff mbox series

doc: fix typo in coding style

Message ID 20211029131902.44827-1-dsosnowski@nvidia.com (mailing list archive)
State Accepted, archived
Delegated to: David Marchand
Headers show
Series doc: fix typo in coding style | expand

Checks

Context Check Description
ci/iol-spell-check-testing success Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-x86_64-unit-testing fail Testing issues
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/intel-Testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/github-robot: build success github build: passed
ci/checkpatch success coding style OK

Commit Message

Dariusz Sosnowski Oct. 29, 2021, 1:19 p.m. UTC
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: stable@dpdk.org

Signed-off-by: Dariusz Sosnowski <dsosnowski@nvidia.com>
---
 doc/guides/contributing/coding_style.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Bruce Richardson Nov. 1, 2021, 2:54 p.m. UTC | #1
On Fri, Oct 29, 2021 at 04:19:02PM +0300, Dariusz Sosnowski wrote:
> 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: stable@dpdk.org
> 
> Signed-off-by: Dariusz Sosnowski <dsosnowski@nvidia.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
David Marchand Nov. 26, 2021, 10:20 a.m. UTC | #2
On Mon, Nov 1, 2021 at 3:54 PM Bruce Richardson
<bruce.richardson@intel.com> wrote:
>
> On Fri, Oct 29, 2021 at 04:19:02PM +0300, Dariusz Sosnowski wrote:
> > 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: stable@dpdk.org
> >
> > Signed-off-by: Dariusz Sosnowski <dsosnowski@nvidia.com>
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Applied, thanks.
diff mbox series

Patch

diff --git a/doc/guides/contributing/coding_style.rst b/doc/guides/contributing/coding_style.rst
index b27b5fcfdb..506f706ebd 100644
--- a/doc/guides/contributing/coding_style.rst
+++ b/doc/guides/contributing/coding_style.rst
@@ -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.