[dpdk-dev] doc: fix documentation for testpmd ddp add del function

Message ID 1517397306-20440-1-git-send-email-kirill.rybalchenko@intel.com
State Accepted, archived
Delegated to: Helin Zhang
Headers show

Checks

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

Commit Message

Kirill Rybalchenko Jan. 31, 2018, 11:15 a.m.
Documentation and help string more clear describe
meaning of arguments for ddp add del function.

Fixes: 856ceb331b0a ("app/testpmd: enable DDP remove profile feature")

Signed-off-by: Kirill Rybalchenko <kirill.rybalchenko@intel.com>
---
 app/test-pmd/cmdline.c                      | 8 ++++----
 doc/guides/nics/i40e.rst                    | 8 ++++----
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 8 ++++----
 3 files changed, 12 insertions(+), 12 deletions(-)

Comments

Mcnamara, John Feb. 1, 2018, 9:24 a.m. | #1
> -----Original Message-----
> From: stable [mailto:stable-bounces@dpdk.org] On Behalf Of Kirill
> Rybalchenko
> Sent: Wednesday, January 31, 2018 11:15 AM
> To: dev@dpdk.org
> Cc: stable@dpdk.org; Rybalchenko, Kirill <kirill.rybalchenko@intel.com>;
> Chilikin, Andrey <andrey.chilikin@intel.com>; Xing, Beilei
> <beilei.xing@intel.com>; Wu, Jingjing <jingjing.wu@intel.com>
> Subject: [dpdk-stable] [PATCH] doc: fix documentation for testpmd ddp add
> del function
> 
> Documentation and help string more clear describe meaning of arguments for
> ddp add del function.
> 
> Fixes: 856ceb331b0a ("app/testpmd: enable DDP remove profile feature")

Acked-by: John McNamara <john.mcnamara@intel.com>
Helin Zhang Feb. 5, 2018, 9:22 a.m. | #2
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Mcnamara, John
> Sent: Thursday, February 1, 2018 5:25 PM
> To: Rybalchenko, Kirill; dev@dpdk.org
> Cc: stable@dpdk.org; Rybalchenko, Kirill; Chilikin, Andrey; Xing, Beilei; Wu,
> Jingjing
> Subject: Re: [dpdk-dev] [dpdk-stable] [PATCH] doc: fix documentation for
> testpmd ddp add del function
> 
> 
> 
> > -----Original Message-----
> > From: stable [mailto:stable-bounces@dpdk.org] On Behalf Of Kirill
> > Rybalchenko
> > Sent: Wednesday, January 31, 2018 11:15 AM
> > To: dev@dpdk.org
> > Cc: stable@dpdk.org; Rybalchenko, Kirill
> > <kirill.rybalchenko@intel.com>; Chilikin, Andrey
> > <andrey.chilikin@intel.com>; Xing, Beilei <beilei.xing@intel.com>; Wu,
> > Jingjing <jingjing.wu@intel.com>
> > Subject: [dpdk-stable] [PATCH] doc: fix documentation for testpmd ddp
> > add del function
> >
> > Documentation and help string more clear describe meaning of arguments
> > for ddp add del function.
> >
> > Fixes: 856ceb331b0a ("app/testpmd: enable DDP remove profile feature")
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>
Applied to dpdk-next-net-intel, thanks!

/Helin
>

Patch

diff --git a/app/test-pmd/cmdline.c b/app/test-pmd/cmdline.c
index 9f12c0f..314386e 100644
--- a/app/test-pmd/cmdline.c
+++ b/app/test-pmd/cmdline.c
@@ -671,10 +671,10 @@  static void cmd_help_long_parsed(void *parsed_result,
 			"	Set default traffic Management hierarchy on a port\n\n"
 
 #endif
-			"ddp add (port_id) (profile_path[,output_path])\n"
+			"ddp add (port_id) (profile_path[,backup_profile_path])\n"
 			"    Load a profile package on a port\n\n"
 
-			"ddp del (port_id) (profile_path)\n"
+			"ddp del (port_id) (backup_profile_path)\n"
 			"    Delete a profile package from a port\n\n"
 
 			"ptype mapping get (port_id) (valid_only)\n"
@@ -14488,7 +14488,7 @@  cmd_ddp_add_parsed(
 cmdline_parse_inst_t cmd_ddp_add = {
 	.f = cmd_ddp_add_parsed,
 	.data = NULL,
-	.help_str = "ddp add <port_id> <profile_path[,output_path]>",
+	.help_str = "ddp add <port_id> <profile_path[,backup_profile_path]>",
 	.tokens = {
 		(void *)&cmd_ddp_add_ddp,
 		(void *)&cmd_ddp_add_add,
@@ -14558,7 +14558,7 @@  cmd_ddp_del_parsed(
 cmdline_parse_inst_t cmd_ddp_del = {
 	.f = cmd_ddp_del_parsed,
 	.data = NULL,
-	.help_str = "ddp del <port_id> <profile_path>",
+	.help_str = "ddp del <port_id> <backup_profile_path>",
 	.tokens = {
 		(void *)&cmd_ddp_del_ddp,
 		(void *)&cmd_ddp_del_del,
diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index 50d5e36..b57c10d 100644
--- a/doc/guides/nics/i40e.rst
+++ b/doc/guides/nics/i40e.rst
@@ -394,17 +394,17 @@  The DDP functionality requires a NIC firmware version of 6.0 or greater.
 Current implementation supports MPLSoUDP/MPLSoGRE/GTP-C/GTP-U/PPPoE/PPPoL2TP,
 steering can be used with rte_flow API.
 
-Load a profile which supports MPLSoUDP/MPLSoGRE:
+Load a profile which supports MPLSoUDP/MPLSoGRE and store backup profile:
 
 .. code-block:: console
 
-   testpmd> ddp add 0 ./mpls.pkgo
+   testpmd> ddp add 0 ./mpls.pkgo,./backup.pkgo
 
-Delete a MPLS profile:
+Delete a MPLS profile and restore backup profile:
 
 .. code-block:: console
 
-   testpmd> ddp del 0 ./mpls.pkgo
+   testpmd> ddp del 0 ./backup.pkgo
 
 Get loaded DDP package info list:
 
diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index d8c9ef0..39650d8 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -1404,16 +1404,16 @@  Delete an E-tag forwarding filter on a port::
 ddp add
 ~~~~~~~
 
-Load a dynamic device personalization (DDP) package::
+Load a dynamic device personalization (DDP) profile and store backup profile::
 
-   testpmd> ddp add (port_id) (package_path[,output_path])
+   testpmd> ddp add (port_id) (profile_path[,backup_profile_path])
 
 ddp del
 ~~~~~~~
 
-Delete a dynamic device personalization package::
+Delete a dynamic device personalization profile and restore backup profile::
 
-   testpmd> ddp del (port_id) (package_path)
+   testpmd> ddp del (port_id) (backup_profile_path)
 
 ptype mapping
 ~~~~~~~~~~~~~