[asterisk-bugs] [JIRA] (ASTERISK-23800) Wiki Documentation - Document commands useful for Asterisk developers

[Richard Mudgett (JIRA)]

    [ https://issues.asterisk.org/jira/browse/ASTERISK-23800?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=218569#comment-218569 ] 

Richard Mudgett commented on ASTERISK-23800:
--------------------------------------------

The bridge commands are not developer specific.  They have some documentation in the CLI help system.

The astobj2 commands *are* developer specific and appear when the system is compiled in developer mode.  They have some documented in the CLI help system as normal.
The main thing that would need more documentation with these developer commands is the fact that the developer can register other containers for the commands to work with by using the following functions:
{code}
int ao2_container_register(const char *name, struct ao2_container *self, ao2_prnt_obj_fn *prnt_obj);
void ao2_container_unregister(const char *name);
{code}


> Wiki Documentation - Document commands useful for Asterisk developers
> ---------------------------------------------------------------------
>
>                 Key: ASTERISK-23800
>                 URL: https://issues.asterisk.org/jira/browse/ASTERISK-23800
>             Project: Asterisk
>          Issue Type: Improvement
>      Security Level: None
>          Components: Documentation
>            Reporter: Rusty Newton
>            Severity: Minor
>
> While looking through the Asterisk 12 CHANGES file I noticed that some commands that would primarily be useful for developers had been added.
> I don't see any documentation on the wiki or elsewhere for these, other than the CHANGES files itself. It may make sense to put something in more places where a new Asterisk developer could learn about them.
> I had already [documented a few commands|https://wiki.asterisk.org/wiki/display/AST/CLI+commands+useful+for+debugging] that we have requested reporters use in certain triage processes. I'm not sure that is the best page or format to document all of the available "development commands".
> As for commands to document, I noticed in the CHANGES file the following:
> {noformat}
> * When compiled with '--enable-dev-mode', the astobj2 library will now add
>    several CLI commands that allow for inspection of ao2 containers that
>    register themselves with astobj2. The CLI commands are 'astobj2 container
>    dump', 'astobj2 container stats', and 'astobj2 container check'.
>  * Added specific CLI commands for bridge inspection. This includes 'bridge
>    show all', which lists all bridges in the system, and 'bridge show {id}',
>    which provides specific information about a bridge.
>  * Added CLI command 'bridge destroy'. This will destroy the specified bridge,
>    ejecting the channels currently in the bridge. If the channels cannot
>    continue in the dialplan or application that put them in the bridge, they
>    will be hung up.
>  * Added command 'bridge kick'. This will eject a single channel from a bridge.
>  * Added commands to inspect and manipulate the registered bridge technologies.
>    This include 'bridge technology show', which lists the registered bridge
>    technologies, as well as 'bridge technology {suspend|unsuspend} {tech}',
>    which controls whether or not a registered bridge technology can be used
>    during smart bridge operations. If a technology is suspended, it will not
>    be used when a bridge technology is picked for channels; when unsuspended,
>    it can be used again.
> {noformat}
> Those were added in 12. We should also look for existing development-useful commands to document along with these.



--
This message was sent by Atlassian JIRA
(v6.2#6252)