kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-07 22:05:25 +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 317b830c1e
commit a22dc33057
31 changed files with 650 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
res/res_resolver_unbound.c
View File

@@ -43,19 +43,23 @@
<configInfo name="res_resolver_unbound" language="en_US">
<configFile name="resolver_unbound.conf">
<configObject name="general">
<since><version>14.1.0</version></since>
<synopsis>General options for res_resolver_unbound</synopsis>
<configOption name="hosts">
<since><version>14.0.0</version></since>
<synopsis>Full path to an optional hosts file</synopsis>
<description><para>Hosts specified in a hosts file will be resolved within the resolver itself. If a value
of system is provided the system-specific file will be used.</para></description>
</configOption>
<configOption name="resolv">
<since><version>14.0.0</version></since>
<synopsis>Full path to an optional resolv.conf file</synopsis>
<description><para>The resolv.conf file specifies the nameservers to contact when resolving queries. If a
value of system is provided the system-specific file will be used. If provided alongside explicit nameservers the
nameservers contained within the resolv.conf file will be used after all others.</para></description>
</configOption>
<configOption name="nameserver">
<since><version>14.0.0</version></since>
<synopsis>Nameserver to use for queries</synopsis>
<description><para>An explicit nameserver can be specified which is used for resolving queries. If multiple
nameserver lines are specified the first will be the primary with failover occurring, in order, to the other
@@ -63,11 +67,13 @@
used before all others.</para></description>
</configOption>
<configOption name="debug">
<since><version>14.0.0</version></since>
<synopsis>Unbound debug level</synopsis>
<description><para>The debugging level for the unbound resolver. While there is no explicit range generally
the higher the number the more debug is output.</para></description>
</configOption>
<configOption name="ta_file">
<since><version>14.0.0</version></since>
<synopsis>Trust anchor file</synopsis>
<description><para>Full path to a file with DS and DNSKEY records in zone file format. This file is provided
to unbound and is used as a source for trust anchors.</para></description>