doc: clarify spaces for alignment note

Message ID 20190311183939.21166-1-ktraynor@redhat.com
State New
Delegated to: Thomas Monjalon
Headers show
Series
  • doc: clarify spaces for alignment note
Related show

Checks

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

Commit Message

Kevin Traynor March 11, 2019, 6:39 p.m.
Make clear that spaces are only for alignments less than tab size.

Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
---
 doc/guides/contributing/coding_style.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Rami Rosen March 11, 2019, 11:08 p.m. | #1
> Make clear that spaces are only for alignments less than tab size.
>
> Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
>

Acked-by: Rami Rosen <ramirose@gmail.com>
Marko Kovacevic March 25, 2019, 11:36 a.m. | #2
> Subject: [dpdk-dev] [PATCH] doc: clarify spaces for alignment note
> 
> Make clear that spaces are only for alignments less than tab size.
> 
> Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
> ---
>  doc/guides/contributing/coding_style.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/doc/guides/contributing/coding_style.rst
> b/doc/guides/contributing/coding_style.rst
> index d96698a73..dd7ddc21e 100644
> --- a/doc/guides/contributing/coding_style.rst
> +++ b/doc/guides/contributing/coding_style.rst
> @@ -348,5 +348,5 @@ General
>  .. note::
> 
> -	Global whitespace rule in DPDK, use tabs for indentation, spaces for
> alignment.
> +	Global whitespace rule in DPDK, use tabs for indentation, spaces for
> smaller alignments.
> 
>  * Do not put any spaces before a tab for indentation.

Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>

Patch

diff --git a/doc/guides/contributing/coding_style.rst b/doc/guides/contributing/coding_style.rst
index d96698a73..dd7ddc21e 100644
--- a/doc/guides/contributing/coding_style.rst
+++ b/doc/guides/contributing/coding_style.rst
@@ -348,5 +348,5 @@  General
 .. note::
 
-	Global whitespace rule in DPDK, use tabs for indentation, spaces for alignment.
+	Global whitespace rule in DPDK, use tabs for indentation, spaces for smaller alignments.
 
 * Do not put any spaces before a tab for indentation.