mirror of
https://github.com/asterisk/asterisk.git
synced 2025-10-12 15:45:18 +00:00
docs: Add version information to configObject and configOption XML elements
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 772221c82a
)
This commit is contained in:
committed by
Asterisk Development Team
parent
791d8fbbc0
commit
3df8b857ea
@@ -45,6 +45,7 @@
|
||||
<synopsis>Resource for integration with Homer using HEPv3</synopsis>
|
||||
<configFile name="hep.conf">
|
||||
<configObject name="general">
|
||||
<since><version>12.2.0</version></since>
|
||||
<synopsis>General settings.</synopsis>
|
||||
<description><para>
|
||||
The <emphasis>general</emphasis> settings section contains information
|
||||
@@ -52,6 +53,7 @@
|
||||
</para>
|
||||
</description>
|
||||
<configOption name="enabled" default="yes">
|
||||
<since><version>12.2.0</version></since>
|
||||
<synopsis>Enable or disable packet capturing.</synopsis>
|
||||
<description>
|
||||
<enumlist>
|
||||
@@ -61,6 +63,7 @@
|
||||
</description>
|
||||
</configOption>
|
||||
<configOption name="uuid_type" default="call-id">
|
||||
<since><version>12.2.0</version></since>
|
||||
<synopsis>The preferred type of UUID to pass to Homer.</synopsis>
|
||||
<description>
|
||||
<enumlist>
|
||||
@@ -70,15 +73,19 @@
|
||||
</description>
|
||||
</configOption>
|
||||
<configOption name="capture_address">
|
||||
<since><version>13.16.0</version><version>14.5.0</version></since>
|
||||
<synopsis>The address and port of the Homer server to send packets to.</synopsis>
|
||||
</configOption>
|
||||
<configOption name="capture_password">
|
||||
<since><version>12.2.0</version></since>
|
||||
<synopsis>If set, the authentication password to send to Homer.</synopsis>
|
||||
</configOption>
|
||||
<configOption name="capture_id" default="0">
|
||||
<since><version>12.2.0</version></since>
|
||||
<synopsis>The ID for this capture agent.</synopsis>
|
||||
</configOption>
|
||||
<configOption name="capture_name" default="">
|
||||
<since><version>18.16.0</version><version>20.1.0</version></since>
|
||||
<synopsis>The name for this capture agent.</synopsis>
|
||||
</configOption>
|
||||
</configObject>
|
||||
|
Reference in New Issue
Block a user