Add CLI configuration documentation
authorMatthew Jordan <mjordan@digium.com>
Fri, 15 Feb 2013 13:38:12 +0000 (13:38 +0000)
committerMatthew Jordan <mjordan@digium.com>
Fri, 15 Feb 2013 13:38:12 +0000 (13:38 +0000)
commitd04ab3c6450f3d92aa004ae9d6e0e7da51f702a3
tree821330ff71a4484afa46ade4a2bbd211c800a992
parentedf0483f4f0e73ded128f1e613b60f31925af102
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
18 files changed:
Makefile
apps/app_skel.c
apps/confbridge/conf_config_parser.c
channels/chan_motif.c
configs/motif.conf.sample
configs/xmpp.conf.sample
doc/appdocsxml.dtd
include/asterisk/_private.h
include/asterisk/config_options.h
include/asterisk/xml.h
include/asterisk/xmldoc.h
main/asterisk.c
main/config_options.c
main/named_acl.c
main/udptl.c
main/xml.c
main/xmldoc.c
res/res_xmpp.c