kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-03 19:28:53 +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.

(cherry picked from commit a22dc33057)
This commit is contained in:
George Joseph
2025-01-16 14:54:35 -07:00
committed by Asterisk Development Team
parent e7801702c6
commit 1ccf0ae7e8
31 changed files with 650 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
res/res_geolocation/geoloc_doc.xml
View File

@@ -5,16 +5,19 @@
<synopsis>Core Geolocation Support</synopsis>
<configFile name="geolocation.conf">
<configObject name="location">
<since><version>16.29.0</version><version>18.15.0</version><version>19.7.0</version></since>
<synopsis>Location</synopsis>
<description>
<para>Parameters for defining a Location object</para>
</description>
<configOption name="type">
<since><version>16.28.0</version><version>18.14.0</version><version>19.6.0</version></since>
<synopsis>Must be of type 'location'.</synopsis>
</configOption>
<configOption name="format" default="none">
<since><version>16.28.0</version><version>18.14.0</version><version>19.6.0</version></since>
<synopsis>Location specification type</synopsis>
<description>
<enumlist>
@@ -46,6 +49,7 @@
</configOption>
<configOption name="location_info" default="none">
<since><version>16.28.0</version><version>18.14.0</version><version>19.6.0</version></since>
<synopsis>Location information</synopsis>
<description>
<para>The contents of this parameter are specific to the
@@ -73,6 +77,7 @@
</configOption>
<configOption name="location_source" default="none">
<since><version>16.28.0</version><version>18.14.0</version><version>19.6.0</version></since>
<synopsis>Fully qualified host name</synopsis>
<description>
<para>This parameter isn't required but if provided, RFC8787 says it MUST be a fully
@@ -83,6 +88,7 @@
</configOption>
<configOption name="method" default="none">
<since><version>16.28.0</version><version>18.14.0</version><version>19.6.0</version></since>
<synopsis>Location determination method</synopsis>
<description>
<para>This is a rarely used field in the specification that would
@@ -101,6 +107,7 @@
</configOption>
<configOption name="confidence" default="none">
<since><version>16.28.0</version><version>18.14.0</version><version>19.6.0</version></since>
<synopsis>Level of confidence</synopsis>
<description>
<para>This is a rarely used field in the specification that would
@@ -131,15 +138,18 @@
</configObject>
<configObject name="profile">
<since><version>16.29.0</version><version>18.15.0</version><version>19.7.0</version></since>
<synopsis>Profile</synopsis>
<description>
<para>Parameters for defining a Profile object</para>
</description>
<configOption name="type">
<since><version>16.28.0</version><version>18.14.0</version><version>19.6.0</version></since>
<synopsis>Must be of type 'profile'.</synopsis>
</configOption>
<configOption name="pidf_element" default="device">
<since><version>16.28.0</version><version>18.14.0</version><version>19.6.0</version></since>
<synopsis>PIDF-LO element to place this profile in</synopsis>
<description>
<enumlist>
@@ -158,17 +168,21 @@
</configOption>
<configOption name="location_reference" default="none">
<since><version>16.28.0</version><version>18.14.0</version><version>19.6.0</version></since>
<synopsis>Reference to a location object</synopsis>
</configOption>
<configOption name="location_info_refinement" default="none">
<since><version>16.28.0</version><version>18.14.0</version><version>19.6.0</version></since>
<synopsis>Reference to a location object</synopsis>
</configOption>
<configOption name="location_variables" default="none">
<since><version>16.28.0</version><version>18.14.0</version><version>19.6.0</version></since>
<synopsis>Reference to a location object</synopsis>
</configOption>
<configOption name="usage_rules" default="empty &lt;usage_rules&gt; element">
<since><version>16.28.0</version><version>18.14.0</version><version>19.6.0</version></since>
<synopsis>location specification type</synopsis>
<description>
<para>xxxx</para>
@@ -176,6 +190,7 @@
</configOption>
<configOption name="notes" default="">
<since><version>16.28.0</version><version>18.14.0</version><version>19.6.0</version></since>
<synopsis>Notes to be added to the outgoing PIDF-LO document</synopsis>
<description>
<para>The specification of this parameter will cause a
@@ -186,15 +201,18 @@
</configOption>
<configOption name="allow_routing_use" default="no">
<since><version>16.28.0</version><version>18.14.0</version><version>19.6.0</version></since>
<synopsis>Sets the value of the Geolocation-Routing header.</synopsis>
</configOption>
<configOption name="suppress_empty_ca_elements" default="no">
<since><version>16.29.0</version><version>18.15.0</version><version>19.7.0</version></since>
<synopsis>Sets if empty Civic Address elements should be suppressed
from the PIDF-LO document.</synopsis>
</configOption>
<configOption name="profile_precedence" default="discard_incoming">
<since><version>16.28.0</version><version>18.14.0</version><version>19.6.0</version></since>
<synopsis>Determine which profile on a channel should be used</synopsis>
<description>
<enumlist>