From: Rusty Newton <rnewton@digium.com>
Date: Thu, 12 Jun 2014 21:17:25 +0000 (+0000)
Subject: main/pbx - documentation - enhance 'core show hints' and 'core show hint' help text
X-Git-Tag: 12.4.0-rc1~52
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3487c5e9113d1980b7cacc960904c1dfde2e86ba;p=thirdparty%2Fasterisk.git

main/pbx - documentation - enhance 'core show hints' and 'core show hint' help text

Adds descriptive help text to 'core show hints' and 'core show hint'. The text describes the various columns for the sake of clarity.

ASTERISK-23764
Review: https://reviewboard.asterisk.org/r/3610/
........

Merged revisions 415998 from http://svn.asterisk.org/svn/asterisk/branches/1.8
........

Merged revisions 415999 from http://svn.asterisk.org/svn/asterisk/branches/11


git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/12@416001 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---

diff --git a/main/pbx.c b/main/pbx.c
index 2c5037df09..cccceafa66 100644
--- a/main/pbx.c
+++ b/main/pbx.c
@@ -7360,7 +7360,12 @@ static char *handle_show_hints(struct ast_cli_entry *e, int cmd, struct ast_cli_
 		e->command = "core show hints";
 		e->usage =
 			"Usage: core show hints\n"
-			"       List registered hints\n";
+			"       List registered hints.\n"
+			"       Hint details are shown in four columns. In order from left to right, they are:\n"
+			"       1. Hint extension URI.\n"
+			"       2. Mapped device state identifiers.\n"
+			"       3. Current extension state. The aggregate of mapped device states.\n"
+			"       4. Watchers - number of subscriptions and other entities watching this hint.\n";
 		return NULL;
 	case CLI_GENERATE:
 		return NULL;
@@ -7446,7 +7451,13 @@ static char *handle_show_hint(struct ast_cli_entry *e, int cmd, struct ast_cli_a
 		e->command = "core show hint";
 		e->usage =
 			"Usage: core show hint <exten>\n"
-			"       List registered hint\n";
+			"       List registered hint.\n"
+			"       Hint details are shown in four columns. In order from left to right, they are:\n"
+			"       1. Hint extension URI.\n"
+			"       2. Mapped device state identifiers.\n"
+			"       3. Current extension state. The aggregate of mapped device states.\n"
+			"       4. Watchers - number of subscriptions and other entities watching this hint.\n";
+
 		return NULL;
 	case CLI_GENERATE:
 		return complete_core_show_hint(a->line, a->word, a->pos, a->n);