kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-12 15:45:18 +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

8
res/res_pjsip_publish_asterisk.c
View File

@@ -48,30 +48,38 @@
</description>
<configFile name="pjsip.conf">
<configObject name="asterisk-publication">
<since><version>13.0.0</version></since>
<synopsis>The configuration for inbound Asterisk event publication</synopsis>
<description><para>
Publish is <emphasis>COMPLETELY</emphasis> separate from the rest of
<literal>pjsip.conf</literal>.
</para></description>
<configOption name="devicestate_publish">
<since><version>13.0.0</version></since>
<synopsis>Optional name of a publish item that can be used to publish a request for full device state information.</synopsis>
</configOption>
<configOption name="mailboxstate_publish">
<since><version>13.0.0</version></since>
<synopsis>Optional name of a publish item that can be used to publish a request for full mailbox state information.</synopsis>
</configOption>
<configOption name="device_state" default="no">
<since><version>13.0.0</version></since>
<synopsis>Whether we should permit incoming device state events.</synopsis>
</configOption>
<configOption name="device_state_filter">
<since><version>13.0.0</version></since>
<synopsis>Optional regular expression used to filter what devices we accept events for.</synopsis>
</configOption>
<configOption name="mailbox_state" default="no">
<since><version>13.0.0</version></since>
<synopsis>Whether we should permit incoming mailbox state events.</synopsis>
</configOption>
<configOption name="mailbox_state_filter">
<since><version>13.0.0</version></since>
<synopsis>Optional regular expression used to filter what mailboxes we accept events for.</synopsis>
</configOption>
<configOption name="type">
<since><version>13.0.0</version></since>
<synopsis>Must be of type 'asterisk-publication'.</synopsis>
</configOption>
</configObject>