doc: fix typo in coding style
Checks
Commit Message
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
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>
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.
@@ -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.