doc: fix DDP usage in testpmd
authorKirill Rybalchenko <kirill.rybalchenko@intel.com>
Wed, 31 Jan 2018 11:15:06 +0000 (11:15 +0000)
committerFerruh Yigit <ferruh.yigit@intel.com>
Mon, 5 Feb 2018 12:42:25 +0000 (13:42 +0100)
Documentation and help string more clear describe meaning of
arguments for DDP add del function.

Fixes: 856ceb331b0a ("app/testpmd: enable DDP remove profile feature")
Cc: stable@dpdk.org
Signed-off-by: Kirill Rybalchenko <kirill.rybalchenko@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
app/test-pmd/cmdline.c
doc/guides/nics/i40e.rst
doc/guides/testpmd_app_ug/testpmd_funcs.rst

index 1e06dcd..b4522f4 100644 (file)
@@ -645,10 +645,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"
@@ -14511,7 +14511,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,
@@ -14581,7 +14581,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,
index 166f447..41945b8 100644 (file)
@@ -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:
 
index a7113a6..1fb8ffb 100644 (file)
@@ -1423,16 +1423,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
 ~~~~~~~~~~~~~