diff mbox series

[3/6] doc: fix miss blank line in testpmd flow syntax doc

Message ID 20221110141506.335016-4-michaelba@nvidia.com (mailing list archive)
State Superseded, archived
Delegated to: Andrew Rybchenko
Headers
Series doc: some fixes |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Michael Baum Nov. 10, 2022, 2:15 p.m. UTC 
  In flow syntax documentation, there is example for create pattern
template.

Before the example, miss a blank line causing it to look regular bold
text.
In addition, inside the example, it uses tab instead of spaces which
expand the indentation in one line.

This patch adds the blank line and replaces tab with spaces.

Fixes: 04cc665fab38 ("app/testpmd: add flow template management")
Cc: akozyrev@nvidia.com
Cc: stable@dpdk.org

Signed-off-by: Michael Baum <michaelba@nvidia.com>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Zhang, Yuying Nov. 11, 2022, 7:02 a.m. UTC | #1 
> -----Original Message-----
> From: Michael Baum <michaelba@nvidia.com>
> Sent: 2022年11月10日 22:15
> To: dev@dpdk.org
> Cc: Matan Azrad <matan@nvidia.com>; Thomas Monjalon
> <thomas@monjalon.net>; Raslan Darawsheh <rasland@nvidia.com>; Singh,
> Aman Deep <aman.deep.singh@intel.com>; Zhang, Yuying
> <yuying.zhang@intel.com>; Andrew Rybchenko
> <andrew.rybchenko@oktetlabs.ru>; akozyrev@nvidia.com; stable@dpdk.org
> Subject: [PATCH 3/6] doc: fix miss blank line in testpmd flow syntax doc
> 
> In flow syntax documentation, there is example for create pattern template.
> 
> Before the example, miss a blank line causing it to look regular bold text.
> In addition, inside the example, it uses tab instead of spaces which expand the
> indentation in one line.
> 
> This patch adds the blank line and replaces tab with spaces.
> 
> Fixes: 04cc665fab38 ("app/testpmd: add flow template management")
> Cc: akozyrev@nvidia.com
> Cc: stable@dpdk.org
> 
> Signed-off-by: Michael Baum <michaelba@nvidia.com>
Acked-by: Yuying Zhang <yuying.zhang@intel.com>

> ---
>  doc/guides/testpmd_app_ug/testpmd_funcs.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> index b5fea1396c..0037506a79 100644
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -2894,9 +2894,10 @@ following sections.
>         [meters_number {number}] [flags {number}]
> 
>  - Create a pattern template::
> +
>     flow pattern_template {port_id} create [pattern_template_id {id}]
>         [relaxed {boolean}] [ingress] [egress] [transfer]
> -	   template {item} [/ {item} [...]] / end
> +       template {item} [/ {item} [...]] / end
> 
>  - Destroy a pattern template::
> 
> --
> 2.25.1
diff mbox series

Patch

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index b5fea1396c..0037506a79 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -2894,9 +2894,10 @@  following sections.
        [meters_number {number}] [flags {number}]
 
 - Create a pattern template::
+
    flow pattern_template {port_id} create [pattern_template_id {id}]
        [relaxed {boolean}] [ingress] [egress] [transfer]
-	   template {item} [/ {item} [...]] / end
+       template {item} [/ {item} [...]] / end
 
 - Destroy a pattern template::