Change in osmo-bts[master]: vty: fix missing / wrong documentation for some commands

[fixeria]

fixeria has submitted this change. ( https://gerrit.osmocom.org/c/osmo-bts/+/21012 )

Change subject: vty: fix missing / wrong documentation for some commands
......................................................................

vty: fix missing / wrong documentation for some commands

Change-Id: Ie2f9e401c0f8f55307d98fa5afe5eb4182add43a
Related: SYS#4937, OS#3036
---
M src/common/vty.c
1 file changed, 18 insertions(+), 8 deletions(-)

Approvals:
  Jenkins Builder: Verified
  pespin: Looks good to me, but someone else must approve
  laforge: Looks good to me, approved



diff --git a/src/common/vty.c b/src/common/vty.c
index 6fe1ca7..7126458 100644
--- a/src/common/vty.c
+++ b/src/common/vty.c
@@ -490,7 +490,9 @@
 	      cfg_bts_rtp_jitbuf_cmd,
 	      X(BTS_VTY_ATTR_NEW_LCHAN),
 	      "rtp jitter-buffer <0-10000> [adaptive]",
-	      RTP_STR "RTP jitter buffer\n" "jitter buffer in ms\n")
+	      RTP_STR "RTP jitter buffer\n"
+	      "Jitter buffer in ms\n"
+	      "Enable adaptive RTP jitter buffering\n")
 {
 	struct gsm_bts *bts = vty->index;
 
@@ -502,9 +504,10 @@
 }
 
 DEFUN(cfg_bts_rtp_port_range,
-	cfg_bts_rtp_port_range_cmd,
-	"rtp port-range <1-65534> <1-65534>",
-      RTP_STR "Range of local ports to use for RTP/RTCP traffic\n")
+      cfg_bts_rtp_port_range_cmd,
+      "rtp port-range <1-65534> <1-65534>",
+      RTP_STR "Range of local ports to use for RTP/RTCP traffic\n"
+      "Port range start (inclusive)\n" "Port range end (inclusive)\n")
 {
 	struct gsm_bts *bts = vty->index;
 	unsigned int start;
@@ -725,7 +728,8 @@
 
 DEFUN(cfg_bts_pcu_sock, cfg_bts_pcu_sock_cmd,
 	"pcu-socket PATH",
-	"Configure the PCU socket file/path name\n")
+	"Configure the PCU socket file/path name\n"
+	"UNIX socket path\n")
 {
 	struct gsm_bts *bts = vty->index;
 
@@ -759,9 +763,13 @@
 	return CMD_SUCCESS;
 }
 
+#define SMSCB_STR \
+	"SMSCB (SMS Cell Broadcast) / CBCH configuration\n"
+
 DEFUN_ATTR(cfg_bts_smscb_max_qlen, cfg_bts_smscb_max_qlen_cmd,
 	   "smscb queue-max-length <1-60>",
-	   "Maximum queue length for SMSCB (CBCH) queue. In count of messages/pages (Default: 15)",
+	   SMSCB_STR "Maximum length of the SMSCB (CBCH) queue\n"
+	   "Length in count of messages/pages (default: 15)\n",
 	   CMD_ATTR_IMMEDIATE)
 {
 	struct gsm_bts *bts = vty->index;
@@ -771,7 +779,8 @@
 
 DEFUN_ATTR(cfg_bts_smscb_tgt_qlen, cfg_bts_smscb_tgt_qlen_cmd,
 	   "smscb queue-target-length <1-30>",
-	   "Target queue length for SMSCB (CBCH) queue. In count of messages/pages (Default: 2)",
+	   SMSCB_STR "Target length of the SMSCB (CBCH) queue\n"
+	   "Length in count of messages/pages (default: 2)\n",
 	   CMD_ATTR_IMMEDIATE)
 {
 	struct gsm_bts *bts = vty->index;
@@ -781,7 +790,8 @@
 
 DEFUN_ATTR(cfg_bts_smscb_qhyst, cfg_bts_smscb_qhyst_cmd,
 	   "smscb queue-hysteresis <0-30>",
-	   "Hysteresis for SMSCB (CBCH) queue. In count of messages/pages (Default: 2)",
+	   SMSCB_STR "Hysteresis of the SMSCB (CBCH) queue\n"
+	   "In count of messages/pages (default: 2)\n",
 	   CMD_ATTR_IMMEDIATE)
 {
 	struct gsm_bts *bts = vty->index;

-- 
To view, visit https://gerrit.osmocom.org/c/osmo-bts/+/21012
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: osmo-bts
Gerrit-Branch: master
Gerrit-Change-Id: Ie2f9e401c0f8f55307d98fa5afe5eb4182add43a
Gerrit-Change-Number: 21012
Gerrit-PatchSet: 2
Gerrit-Owner: fixeria <vyanitskiy at sysmocom.de>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: fixeria <vyanitskiy at sysmocom.de>
Gerrit-Reviewer: laforge <laforge at osmocom.org>
Gerrit-Reviewer: pespin <pespin at sysmocom.de>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20201102/6d6245d6/attachment.htm>