main/pbx - documentation - enhance 'core show hints' and 'core show hint' help text
authorRusty Newton <rnewton@digium.com>
Thu, 12 Jun 2014 21:27:02 +0000 (21:27 +0000)
committerRusty Newton <rnewton@digium.com>
Thu, 12 Jun 2014 21:27:02 +0000 (21:27 +0000)
Adds descriptive help text to 'core show hints' and 'core show hint'. The text describes the various columns for the sake of clarity. It takes into account recent changes to the content displayed by the commands https://reviewboard.asterisk.org/r/3604/ and https://reviewboard.asterisk.org/r/3611/.

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

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

main/pbx.c

index 67108f6..b1c50e5 100644 (file)
@@ -7374,7 +7374,13 @@ 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"
                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 five columns. In order from left to right, they are:\n"
+                       "       1. Hint extension URI.\n"
+                       "       2. List of mapped device or presence state identifiers.\n"
+                       "       3. Current extension state. The aggregate of mapped device states.\n"
+                       "       4. Current presence state for the mapped presence state provider.\n"
+                       "       5. Watchers - number of subscriptions and other entities watching this hint.\n";
                return NULL;
        case CLI_GENERATE:
                return NULL;
                return NULL;
        case CLI_GENERATE:
                return NULL;
@@ -7467,7 +7473,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"
                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 five columns. In order from left to right, they are:\n"
+                       "       1. Hint extension URI.\n"
+                       "       2. List of mapped device or presence state identifiers.\n"
+                       "       3. Current extension state. The aggregate of mapped device states.\n"
+                       "       4. Current presence state for the mapped presence state provider.\n"
+                       "       5. 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);
                return NULL;
        case CLI_GENERATE:
                return complete_core_show_hint(a->line, a->word, a->pos, a->n);