diff options
| author | Matthew Jordan <mjordan@digium.com> | 2013-02-15 13:38:12 +0000 |
|---|---|---|
| committer | Matthew Jordan <mjordan@digium.com> | 2013-02-15 13:38:12 +0000 |
| commit | d04ab3c6450f3d92aa004ae9d6e0e7da51f702a3 (patch) | |
| tree | 821330ff71a4484afa46ade4a2bbd211c800a992 /main/udptl.c | |
| parent | edf0483f4f0e73ded128f1e613b60f31925af102 (diff) | |
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
Diffstat (limited to 'main/udptl.c')
| -rw-r--r-- | main/udptl.c | 37 |
1 files changed, 36 insertions, 1 deletions
diff --git a/main/udptl.c b/main/udptl.c index 37f04d530..8ae8334a9 100644 --- a/main/udptl.c +++ b/main/udptl.c @@ -80,6 +80,40 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$") #include "asterisk/cli.h" #include "asterisk/unaligned.h" +/*** DOCUMENTATION + <configInfo name="udptl" language="en_US"> + <configFile name="udptl.conf"> + <configObject name="global"> + <synopsis>Global options for configuring UDPTL</synopsis> + <configOption name="udptlstart"> + <synopsis>The start of the UDPTL port range</synopsis> + </configOption> + <configOption name="udptlend"> + <synopsis>The end of the UDPTL port range</synopsis> + </configOption> + <configOption name="udptlchecksums"> + <synopsis>Whether to enable or disable UDP checksums on UDPTL traffic</synopsis> + </configOption> + <configOption name="udptlfecentries"> + <synopsis>The number of error correction entries in a UDPTL packet</synopsis> + </configOption> + <configOption name="udptlfecspan"> + <synopsis>The span over which parity is calculated for FEC in a UDPTL packet</synopsis> + </configOption> + <configOption name="use_even_ports"> + <synopsis>Whether to only use even-numbered UDPTL ports</synopsis> + </configOption> + <configOption name="t38faxudpec"> + <synopsis>Removed</synopsis> + </configOption> + <configOption name="t38faxmaxdatagram"> + <synopsis>Removed</synopsis> + </configOption> + </configObject> + </configFile> + </configInfo> +***/ + #define UDPTL_MTU 1200 #if !defined(FALSE) @@ -206,6 +240,7 @@ static int udptl_pre_apply_config(void); static struct aco_type general_option = { .type = ACO_GLOBAL, + .name = "global", .category_match = ACO_WHITELIST, .item_offset = offsetof(struct udptl_config, general), .category = "^general$", @@ -218,7 +253,7 @@ static struct aco_file udptl_conf = { .types = ACO_TYPES(&general_option), }; -CONFIG_INFO_STANDARD(cfg_info, globals, udptl_snapshot_alloc, +CONFIG_INFO_CORE("udptl", cfg_info, globals, udptl_snapshot_alloc, .files = ACO_FILES(&udptl_conf), .pre_apply_config = udptl_pre_apply_config, ); |