kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-03 11:11:05 +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
parent fb533fcc73
commit 772221c82a
31 changed files with 650 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
res/res_pjsip_endpoint_identifier_ip.c
View File

@@ -38,6 +38,7 @@
<synopsis>Module that identifies endpoints</synopsis>
<configFile name="pjsip.conf">
<configObject name="identify">
<since><version>13.14.0</version><version>14.3.0</version></since>
<synopsis>Identifies endpoints via some criteria.</synopsis>
<description>
<para>This module provides alternatives to matching inbound requests to
@@ -54,9 +55,11 @@
<emphasis>any</emphasis> of the criteria.</para></note>
</description>
<configOption name="endpoint">
<since><version>12.0.0</version></since>
<synopsis>Name of endpoint identified</synopsis>
</configOption>
<configOption name="match">
<since><version>12.2.0</version></since>
<synopsis>IP addresses or networks to match against.</synopsis>
<description>
<para>The value is a comma-delimited list of IP addresses or
@@ -83,6 +86,7 @@
</description>
</configOption>
<configOption name="srv_lookups" default="yes">
<since><version>13.14.0</version><version>14.3.0</version></since>
<synopsis>Perform SRV lookups for provided hostnames.</synopsis>
<description>
<para>When enabled, <replaceable>srv_lookups</replaceable> will
@@ -93,6 +97,7 @@
</description>
</configOption>
<configOption name="match_header">
<since><version>13.15.0</version><version>14.4.0</version></since>
<synopsis>Header/value pair to match against.</synopsis>
<description>
<para>A SIP header whose value is used to match against. SIP
@@ -111,6 +116,7 @@
</description>
</configOption>
<configOption name="match_request_uri">
<since><version>18.23.0</version><version>20.8.0</version><version>21.3.0</version></since>
<synopsis>Request URI to match against.</synopsis>
<description>
<para>The SIP request URI is used to match against.
@@ -125,6 +131,7 @@
</description>
</configOption>
<configOption name="type">
<since><version>12.0.0</version></since>
<synopsis>Must be of type 'identify'.</synopsis>
</configOption>
</configObject>