(nuttx-apps) branch master updated: nsh cmd rptun: add rptun ping useage description

[xiaoxiang]

This is an automated email from the ASF dual-hosted git repository.

xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx-apps.git


The following commit(s) were added to refs/heads/master by this push:
     new 51762a895 nsh cmd rptun: add rptun ping useage description
51762a895 is described below

commit 51762a89587e82fc7318f5ed270106a62aa269c4
Author: wangyongrong <wangyongr...@xiaomi.com>
AuthorDate: Fri Nov 3 18:10:07 2023 +0800

    nsh cmd rptun: add rptun ping useage description
    
    Signed-off-by: wangyongrong <wangyongr...@xiaomi.com>
---
 nshlib/nsh_command.c |  2 +-
 nshlib/nsh_syscmds.c | 21 +++++++++++++++++++++
 2 files changed, 22 insertions(+), 1 deletion(-)

diff --git a/nshlib/nsh_command.c b/nshlib/nsh_command.c
index 4320aabfb..cb0420af5 100644
--- a/nshlib/nsh_command.c
+++ b/nshlib/nsh_command.c
@@ -514,7 +514,7 @@ static const struct cmdmap_s g_cmdmap[] =
 #endif
 
 #if defined(CONFIG_RPTUN) && !defined(CONFIG_NSH_DISABLE_RPTUN)
-  CMD_MAP("rptun",    cmd_rptun,    3, 7,
+  CMD_MAP("rptun",    cmd_rptun,    2, 7,
     "<start|stop|reset|panic|dump|ping> <path|all>"
     " [value|times length ack sleep]"),
 #endif
diff --git a/nshlib/nsh_syscmds.c b/nshlib/nsh_syscmds.c
index eb81fbb1b..82bc405d2 100644
--- a/nshlib/nsh_syscmds.c
+++ b/nshlib/nsh_syscmds.c
@@ -605,6 +605,27 @@ static int cmd_rptun_recursive(FAR struct nsh_vtbl_s *vtbl,
 
 int cmd_rptun(FAR struct nsh_vtbl_s *vtbl, int argc, FAR char **argv)
 {
+  if (argc >= 2 && strcmp(argv[1], "-h") == 0)
+    {
+      nsh_output(vtbl, "usage:\n");
+      nsh_output(vtbl, "  rptun <start|stop|reset|panic|dump> <path> "
+                "<value>\n");
+      nsh_output(vtbl, "  rptun <reset> <path> <resetvalue>\n");
+      nsh_output(vtbl, "  rptun ping <path> <times> <length> <ack> "
+                "<period(ms)>\n\n");
+      nsh_output(vtbl, "  <path>         Rptun device path.\n");
+      nsh_output(vtbl, "  <times>        Times of rptun ping.\n");
+      nsh_output(vtbl, "  <length>       The length of each ping packet.\n");
+      nsh_output(vtbl, "  <ack>          Whether the peer acknowlege or "
+                "check data.\n");
+      nsh_output(vtbl, "                 0 - No acknowledge and check.\n");
+      nsh_output(vtbl, "                 1 - Acknowledge, no data check.\n");
+      nsh_output(vtbl, "                 2 - Acknowledge and data check.\n");
+      nsh_output(vtbl, "  <period(ms)>   ping period (ms) \n\n");
+
+      return OK;
+    }
+
   if (argc < 3)
     {
       nsh_output(vtbl, g_fmtargrequired, argv[0]);