Add CLI configuration documentation

This patch allows a module to define its configuration in XML in source, such
that it can be parsed by the XML documentation engine. Documentation is
generated in a two-pass approach:

1. The documentation is first generated from the XML pulled from the source
2. The documentation is then enhanced by the registration of configuration
   options that use the configuration framework

This patch include configuration documentation for the following modules:
 * chan_motif
 * res_xmpp
 * app_confbridge
 * app_skel
 * udptl

Two new CLI commands have been added:
 * config show help - show configuration help by module, category, and item
 * xmldoc dump - dump the in-memory representation of the XML documentation to
   a new XML file.

Review: https://reviewboard.asterisk.org/r/2278
Review: https://reviewboard.asterisk.org/r/2058

patches:
  on review 2058 uploaded by twilson



git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@381527 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Matthew Jordan
2013-02-15 13:38:12 +00:00
parent edf0483f4f
commit d04ab3c645
18 changed files with 1762 additions and 74 deletions

View File

@@ -75,18 +75,25 @@ context=incoming-motif ; Default context that incoming sessions will land in
;maxpayloads = 30 ; Maximum number of payloads we will offer
; Sample configuration entry for Jingle
[jingle-endpoint](default)
transport=ice-udp ; Change the default protocol of outgoing sessions to Jingle ICE-UDP
allow=g722 ; Add G.722 as an allowed format since the other side may support it
connection=local-jabber-account ; Connection to accept traffic on and send traffic out
accountcode=jingle ; Account code for CDR purposes
;[jingle-endpoint](default)
;transport=ice-udp ; Change the default protocol of outgoing sessions to Jingle ICE-UDP
;allow=g722 ; Add G.722 as an allowed format since the other side may support it
;connection=local-jabber-account ; Connection to accept traffic on and send traffic out
;accountcode=jingle ; Account code for CDR purposes
; Sample configuration entry for Google Talk
[gtalk-endpoint](default)
transport=google ; Since this is a Google Talk endpoint we want to offer Google Jingle for outgoing sessions
connection=gtalk-account
;transport=google ; Since this is a Google Talk endpoint we want to offer Google Jingle for outgoing sessions
;connection=gtalk-account
; Sample configuration entry for Google Voice
[gvoice](default)
transport=google-v1 ; Google Voice uses the original Google Talk protocol
connection=gvoice-account
;[gvoice](default)
;transport=google-v1 ; Google Voice uses the original Google Talk protocol
;connection=gvoice-account
; Additional options
; callgroup
; pickupgroup
; language
; musicclass
; parkinglot

View File

@@ -37,3 +37,6 @@
;sendtodialplan=yes ; Send incoming messages into the dialplan. Off by default.
;context=messages ; Dialplan context to send incoming messages to. If not set,
; "default" will be used.
;forceoldssl=no ; Force the use of old-style SSL.
;keepalive=