[asterisk-commits] rmudgett: branch rmudgett/bridge_phase r385371 - in /team/rmudgett/bridge_pha...

[SVN commits to the Asterisk project]

Author: rmudgett
Date: Thu Apr 11 15:21:30 2013
New Revision: 385371

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=385371
Log:
Address reviewboard comments.  Tweaked comments and new CLI command documentation.

Modified:
    team/rmudgett/bridge_phase/include/asterisk/bridging.h
    team/rmudgett/bridge_phase/main/bridging.c

Modified: team/rmudgett/bridge_phase/include/asterisk/bridging.h
URL: http://svnview.digium.com/svn/asterisk/team/rmudgett/bridge_phase/include/asterisk/bridging.h?view=diff&rev=385371&r1=385370&r2=385371
==============================================================================
--- team/rmudgett/bridge_phase/include/asterisk/bridging.h (original)
+++ team/rmudgett/bridge_phase/include/asterisk/bridging.h Thu Apr 11 15:21:30 2013
@@ -405,7 +405,7 @@
  * \brief Register the new bridge with the system.
  * \since 12.0.0
  *
- * \param bridge What to register. (Tollerates a NULL pointer)
+ * \param bridge What to register. (Tolerates a NULL pointer)
  *
  * \code
  * struct ast_bridge *ast_bridge_basic_new(uint32_t capabilities, int flags)
@@ -451,7 +451,7 @@
 /*!
  * \brief Initialize the base class of the bridge.
  *
- * \param self Bridge to operate upon. (Tollerates a NULL pointer)
+ * \param self Bridge to operate upon. (Tolerates a NULL pointer)
  * \param capabilities The capabilities that we require to be used on the bridge
  * \param flags Flags that will alter the behavior of the bridge
  *

Modified: team/rmudgett/bridge_phase/main/bridging.c
URL: http://svnview.digium.com/svn/asterisk/team/rmudgett/bridge_phase/main/bridging.c?view=diff&rev=385371&r1=385370&r2=385371
==============================================================================
--- team/rmudgett/bridge_phase/main/bridging.c (original)
+++ team/rmudgett/bridge_phase/main/bridging.c Thu Apr 11 15:21:30 2013
@@ -4176,13 +4176,13 @@
 		e->command = "bridge show all";
 		e->usage =
 			"Usage: bridge show all\n"
-			"       Lists active bridges\n";
+			"       List all bridges\n";
 		return NULL;
 	case CLI_GENERATE:
 		return NULL;
 	}
 
-	ast_cli(a->fd, FORMAT_HDR, "Bridge ID", "Chans", "Type", "Technology");
+	ast_cli(a->fd, FORMAT_HDR, "Bridge-ID", "Chans", "Type", "Technology");
 	iter = ao2_iterator_init(bridges, 0);
 	for (; (bridge = ao2_iterator_next(&iter)); ao2_ref(bridge, -1)) {
 		ast_bridge_lock(bridge);
@@ -4210,7 +4210,7 @@
 		e->command = "bridge show";
 		e->usage =
 			"Usage: bridge show <bridge-id>\n"
-			"       Show a specific bridge\n";
+			"       Show information about the <bridge-id> bridge\n";
 		return NULL;
 	case CLI_GENERATE:
 		if (a->pos == 2) {
@@ -4253,7 +4253,7 @@
 		e->command = "bridge destroy";
 		e->usage =
 			"Usage: bridge destroy <bridge-id>\n"
-			"       Destroy a specific bridge\n";
+			"       Destroy the <bridge-id> bridge\n";
 		return NULL;
 	case CLI_GENERATE:
 		if (a->pos == 2) {
@@ -4315,8 +4315,8 @@
 	case CLI_INIT:
 		e->command = "bridge kick";
 		e->usage =
-			"Usage: bridge kick <bridge-id> <channel>\n"
-			"       Kick a channel out of a bridge\n";
+			"Usage: bridge kick <bridge-id> <channel-name>\n"
+			"       Kick the <channel-name> channel out of the <bridge-id> bridge\n";
 		return NULL;
 	case CLI_GENERATE:
 		if (a->pos == 2) {
@@ -4362,7 +4362,7 @@
 		e->command = "bridge technology show";
 		e->usage =
 			"Usage: bridge technology show\n"
-			"       Lists registered bridge technologies\n";
+			"       List registered bridge technologies\n";
 		return NULL;
 	case CLI_GENERATE:
 		return NULL;
@@ -4442,8 +4442,8 @@
 	case CLI_INIT:
 		e->command = "bridge technology {suspend|unsuspend}";
 		e->usage =
-			"Usage: bridge technology {suspend|unsuspend} <technology>\n"
-			"       Suspend or unsuspend the specified bridge technology.\n";
+			"Usage: bridge technology {suspend|unsuspend} <technology-name>\n"
+			"       Suspend or unsuspend a bridge technology.\n";
 		return NULL;
 	case CLI_GENERATE:
 		if (a->pos == 3) {
@@ -4486,12 +4486,12 @@
 }
 
 static struct ast_cli_entry bridge_cli[] = {
-	AST_CLI_DEFINE(handle_bridge_show_all, "List bridges"),
-	AST_CLI_DEFINE(handle_bridge_show_specific, "Show a specific bridge"),
-	AST_CLI_DEFINE(handle_bridge_destroy_specific, "Destroy specific bridge"),
+	AST_CLI_DEFINE(handle_bridge_show_all, "List all bridges"),
+	AST_CLI_DEFINE(handle_bridge_show_specific, "Show information about a bridge"),
+	AST_CLI_DEFINE(handle_bridge_destroy_specific, "Destroy a bridge"),
 	AST_CLI_DEFINE(handle_bridge_kick_channel, "Kick a channel from a bridge"),
-	AST_CLI_DEFINE(handle_bridge_technology_show, "List bridge technologies"),
-	AST_CLI_DEFINE(handle_bridge_technology_suspend, "Suspend/unsuspend bridge technology"),
+	AST_CLI_DEFINE(handle_bridge_technology_show, "List registered bridge technologies"),
+	AST_CLI_DEFINE(handle_bridge_technology_suspend, "Suspend/unsuspend a bridge technology"),
 };
 
 /*!