doc: fix two typos in contributing guide

Message ID 20190315091900.18996-1-ramirose@gmail.com
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series
  • doc: fix two typos in contributing guide
Related show

Checks

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

Commit Message

Rami Rosen March 15, 2019, 9:19 a.m.
This patch fixes two typos in the coding style part of 
DPDK contributing guide:

- The header entry should have .h file instead of .c file.
- The will->This will

Fixes: 44a6dface13b ("doc: describe how to add new components")

Signed-off-by: Rami Rosen <ramirose@gmail.com>
---
 doc/guides/contributing/coding_style.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Kovacevic, Marko March 15, 2019, 10:39 a.m. | #1
> This patch fixes two typos in the coding style part of DPDK contributing guide:
> 
> - The header entry should have .h file instead of .c file.
> - The will->This will
> 
> Fixes: 44a6dface13b ("doc: describe how to add new components")
> 
> Signed-off-by: Rami Rosen <ramirose@gmail.com>
> ---
>  doc/guides/contributing/coding_style.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/contributing/coding_style.rst
> b/doc/guides/contributing/coding_style.rst
> index d96698a73..656563dde 100644
> --- a/doc/guides/contributing/coding_style.rst
> +++ b/doc/guides/contributing/coding_style.rst
> @@ -825,10 +825,10 @@ format.
>  .. code-block:: python
> 
>  	sources = files('file1.c', ...)
> -	headers = files('file1.c', ...)
> +	headers = files('file1.h', ...)
> 
> 
> -The will build based on a number of conventions and assumptions within the
> DPDK
> +This will build based on a number of conventions and assumptions within
> +the DPDK
>  itself, for example, that the library name is the same as the directory name
> in  which the files are stored.

Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
Thomas Monjalon April 5, 2019, 8 a.m. | #2
15/03/2019 11:39, Kovacevic, Marko:
> > This patch fixes two typos in the coding style part of DPDK contributing guide:
> > 
> > - The header entry should have .h file instead of .c file.
> > - The will->This will
> > 
> > Fixes: 44a6dface13b ("doc: describe how to add new components")

+Cc: stable@dpdk.org

> > Signed-off-by: Rami Rosen <ramirose@gmail.com>
> 
> Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>

Applied, thanks

Patch

diff --git a/doc/guides/contributing/coding_style.rst b/doc/guides/contributing/coding_style.rst
index d96698a73..656563dde 100644
--- a/doc/guides/contributing/coding_style.rst
+++ b/doc/guides/contributing/coding_style.rst
@@ -825,10 +825,10 @@  format.
 .. code-block:: python
 
 	sources = files('file1.c', ...)
-	headers = files('file1.c', ...)
+	headers = files('file1.h', ...)
 
 
-The will build based on a number of conventions and assumptions within the DPDK
+This will build based on a number of conventions and assumptions within the DPDK
 itself, for example, that the library name is the same as the directory name in
 which the files are stored.