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

docs: Add version information to configObject and configOption XML elements

Browse Source 
Most of the configObjects and configOptions that are implemented with
ACO or Sorcery now have `<since>/<version>` elements added.  There are
probably some that the script I used didn't catch.  The version tags were
determined by the following...
 * Do a git blame on the API call that created the object or option.
 * From the commit hash, grab the summary line.
 * Do a `git log --grep <summary>` to find the cherry-pick commits in all
   branches that match.
 * Do a `git patch-id` to ensure the commits are all related and didn't get
   a false match on the summary.
 * Do a `git tag --contains <commit>` to find the tags that contain each
   commit.
 * Weed out all tags not <major>.<minor>.0.
 * Sort and discard any <major>.0.0 and following tags where the commit
   appeared in an earlier branch.
 * The result is a single tag for each branch where the API was last touched.

configObjects and configOptions elements implemented with the base
ast_config APIs were just not possible to find due to the non-deterministic
way they are accessed.

Also note that if the API call was on modified after it was added, the
version will be the one it was last modified in.

Final note:  The configObject and configOption elements were introduced in
12.0.0 so options created before then may not have any XML documentation.
This commit is contained in:
George Joseph
2025-01-16 14:54:35 -07:00
committed by asterisk-org-access-app[bot]
parent ff0fb401ae
commit 316693ded9
31 changed files with 650 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
res/res_xmpp.c
View File

@@ -276,11 +276,14 @@
<synopsis>XMPP Messaging</synopsis>
<configFile name="xmpp.conf">
<configObject name="global">
<since><version>12.0.0</version></since>
<synopsis>Global configuration settings</synopsis>
<configOption name="debug">
<since><version>11.0.0</version></since>
<synopsis>Enable/disable XMPP message debugging</synopsis>
</configOption>
<configOption name="autoprune">
<since><version>11.0.0</version></since>
<synopsis>Auto-remove users from buddy list.</synopsis>
<description><para>Auto-remove users from buddy list. Depending on the setup
(e.g., using your personal Gtalk account for a test) this could cause loss of
@@ -288,54 +291,71 @@
</para></description>
</configOption>
<configOption name="autoregister">
<since><version>11.0.0</version></since>
<synopsis>Auto-register users from buddy list</synopsis>
</configOption>
<configOption name="collection_nodes">
<since><version>11.0.0</version></since>
<synopsis>Enable support for XEP-0248 for use with distributed device state</synopsis>
</configOption>
<configOption name="pubsub_autocreate">
<since><version>11.0.0</version></since>
<synopsis>Whether or not the PubSub server supports/is using auto-create for nodes</synopsis>
</configOption>
<configOption name="auth_policy">
<since><version>11.0.0</version></since>
<synopsis>Whether to automatically accept or deny users' subscription requests</synopsis>
</configOption>
</configObject>
<configObject name="client">
<since><version>12.0.0</version></since>
<synopsis>Configuration options for an XMPP client</synopsis>
<configOption name="username">
<since><version>11.0.0</version></since>
<synopsis>XMPP username with optional resource</synopsis>
</configOption>
<configOption name="secret">
<since><version>11.0.0</version></since>
<synopsis>XMPP password</synopsis>
</configOption>
<configOption name="refresh_token">
<since><version>13.18.0</version><version>14.7.0</version><version>15.1.0</version></since>
<synopsis>Google OAuth 2.0 refresh token</synopsis>
</configOption>
<configOption name="oauth_clientid">
<since><version>13.18.0</version><version>14.7.0</version><version>15.1.0</version></since>
<synopsis>Google OAuth 2.0 application's client id</synopsis>
</configOption>
<configOption name="oauth_secret">
<since><version>13.18.0</version><version>14.7.0</version><version>15.1.0</version></since>
<synopsis>Google OAuth 2.0 application's secret</synopsis>
</configOption>
<configOption name="serverhost">
<since><version>11.0.0</version></since>
<synopsis>Route to server, e.g. talk.google.com</synopsis>
</configOption>
<configOption name="statusmessage">
<since><version>11.0.0</version></since>
<synopsis>Custom status message</synopsis>
</configOption>
<configOption name="pubsub_node">
<since><version>11.0.0</version></since>
<synopsis>Node for publishing events via PubSub</synopsis>
</configOption>
<configOption name="context">
<since><version>11.0.0</version></since>
<synopsis>Dialplan context to send incoming messages to</synopsis>
</configOption>
<configOption name="priority">
<since><version>11.0.0</version></since>
<synopsis>XMPP resource priority</synopsis>
</configOption>
<configOption name="port">
<since><version>11.0.0</version></since>
<synopsis>XMPP server port</synopsis>
</configOption>
<configOption name="timeout">
<since><version>11.0.0</version></since>
<synopsis>Timeout in seconds to hold incoming messages</synopsis>
<description><para>Timeout (in seconds) on the message stack. Messages stored longer
than this value will be deleted by Asterisk. This option applies to incoming messages only
@@ -343,27 +363,35 @@
</para></description>
</configOption>
<configOption name="debug">
<since><version>11.0.0</version></since>
<synopsis>Enable debugging</synopsis>
</configOption>
<configOption name="type">
<since><version>11.0.0</version></since>
<synopsis>Connection is either a client or a component</synopsis>
</configOption>
<configOption name="distribute_events">
<since><version>11.0.0</version></since>
<synopsis>Whether or not to distribute events using this connection</synopsis>
</configOption>
<configOption name="usetls">
<since><version>11.0.0</version></since>
<synopsis>Whether to use TLS for the connection or not</synopsis>
</configOption>
<configOption name="usesasl">
<since><version>11.0.0</version></since>
<synopsis>Whether to use SASL for the connection or not</synopsis>
</configOption>
<configOption name="forceoldssl">
<since><version>11.0.0</version></since>
<synopsis>Force the use of old-style SSL for the connection</synopsis>
</configOption>
<configOption name="keepalive">
<since><version>11.0.0</version></since>
<synopsis>If enabled, periodically send an XMPP message from this client with an empty message</synopsis>
</configOption>
<configOption name="autoprune">
<since><version>11.18.0</version><version>13.4.0</version></since>
<synopsis>Auto-remove users from buddy list.</synopsis>
<description><para>Auto-remove users from buddy list. Depending on the setup
(e.g., using your personal Gtalk account for a test) this could cause loss of
@@ -371,15 +399,19 @@
</para></description>
</configOption>
<configOption name="autoregister">
<since><version>11.18.0</version><version>13.4.0</version></since>
<synopsis>Auto-register users bfrom buddy list</synopsis>
</configOption>
<configOption name="auth_policy">
<since><version>11.18.0</version><version>13.4.0</version></since>
<synopsis>Whether to automatically accept or deny users' subscription requests</synopsis>
</configOption>
<configOption name="sendtodialplan">
<since><version>11.0.0</version></since>
<synopsis>Send incoming messages into the dialplan</synopsis>
</configOption>
<configOption name="status">
<since><version>11.0.0</version></since>
<synopsis>Default XMPP status for the client</synopsis>
<description><para>Can be one of the following XMPP statuses:</para>
<enumlist>
@@ -392,6 +424,7 @@
</description>
</configOption>
<configOption name="buddy">
<since><version>11.0.0</version></since>
<synopsis>Manual addition of buddy to list</synopsis>
<description><para>
Manual addition of buddy to the buddy list. For distributed events, these buddies are