kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-03 03:20:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add CLI configuration documentation

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

37
main/udptl.c
View File

@@ -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,
);