kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-03 11:25:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add version information to manager event instance XML elements

Browse Source 
* Do a git blame on the embedded XML managerEvent elements.

* 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 ..0.

* Sort and discard any .0.0 and following tags where the commit
  appeared in an earlier branch.

* The result is a single tag for each branch where the application or function
  was defined.

The events defined in res/res_pjsip/pjsip_manager.xml were done by hand
because the XML was extracted from the C source file relatively recently.

Two bugs were fixed along the way...

* The get_documentation awk script was exiting after it processed the first
  DOCUMENTATION block it found in a file.  We have at least 1 source file
  with multiple DOCUMENTATION blocks so only the first one in them was being
  processed.  The awk script was changed to continue searching rather
  than exiting after the first block.

* Fixing the awk script revealed an issue in logger.c where the third
  DOCUMENTATION block contained a XML fragment that consisted only of
  a managerEventInstance element that wasn't wrapped in a managerEvent
  element.  Since logger_doc.xml already existed, the remaining fragments
  in logger.c were moved to it and properly organized.

(cherry picked from commit 2897d87a99)
This commit is contained in:
George Joseph
2025-01-20 11:33:20 -07:00
committed by Asterisk Development Team
parent 571d48fb7c
commit 3fc90e7810
45 changed files with 197 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
res/parking/parking_manager.c
View File

@@ -116,6 +116,7 @@
</manager>
<managerEvent language="en_US" name="ParkedCall">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel is parked.</synopsis>
<syntax>
<channel_snapshot prefix="Parkee"/>
@@ -139,6 +140,7 @@
</managerEvent>
<managerEvent language="en_US" name="ParkedCallTimeOut">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel leaves a parking lot due to reaching the time limit of being parked.</synopsis>
<syntax>
<channel_snapshot prefix="Parkee"/>
@@ -149,6 +151,7 @@
</managerEvent>
<managerEvent language="en_US" name="ParkedCallGiveUp">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel leaves a parking lot because it hung up without being answered.</synopsis>
<syntax>
<channel_snapshot prefix="Parkee"/>
@@ -159,6 +162,7 @@
</managerEvent>
<managerEvent language="en_US" name="UnParkedCall">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel leaves a parking lot because it was retrieved from the parking lot and reconnected.</synopsis>
<syntax>
<channel_snapshot prefix="Parkee"/>
@@ -170,6 +174,7 @@
</managerEvent>
<managerEvent language="en_US" name="ParkedCallSwap">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>13.5.0</version></since>
<synopsis>Raised when a channel takes the place of a previously parked channel</synopsis>
<syntax>
<channel_snapshot prefix="Parkee"/>

5
res/res_agi.c
View File

@@ -1295,6 +1295,7 @@
</manager>
<managerEvent language="en_US" name="AsyncAGIStart">
<managerEventInstance class="EVENT_FLAG_AGI">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel starts AsyncAGI command processing.</synopsis>
<syntax>
<channel_snapshot/>
@@ -1312,6 +1313,7 @@
</managerEvent>
<managerEvent language="en_US" name="AsyncAGIEnd">
<managerEventInstance class="EVENT_FLAG_AGI">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel stops AsyncAGI command processing.</synopsis>
<syntax>
<channel_snapshot/>
@@ -1326,6 +1328,7 @@
</managerEvent>
<managerEvent language="en_US" name="AsyncAGIExec">
<managerEventInstance class="EVENT_FLAG_AGI">
<since><version>12.0.0</version></since>
<synopsis>Raised when AsyncAGI completes an AGI command.</synopsis>
<syntax>
<channel_snapshot/>
@@ -1346,6 +1349,7 @@
</managerEvent>
<managerEvent language="en_US" name="AGIExecStart">
<managerEventInstance class="EVENT_FLAG_AGI">
<since><version>12.0.0</version></since>
<synopsis>Raised when a received AGI command starts processing.</synopsis>
<syntax>
<channel_snapshot/>
@@ -1364,6 +1368,7 @@
</managerEvent>
<managerEvent language="en_US" name="AGIExecEnd">
<managerEventInstance class="EVENT_FLAG_AGI">
<since><version>12.0.0</version></since>
<synopsis>Raised when a received AGI command completes processing.</synopsis>
<syntax>
<channel_snapshot/>

4
res/res_fax.c
View File

@@ -258,6 +258,7 @@
</manager>
<managerEvent language="en_US" name="FAXSessionsEntry">
<managerEventInstance class="EVENT_FLAG_REPORTING">
<since><version>13.0.0</version></since>
<synopsis>A single list item for the FAXSessions AMI command</synopsis>
<syntax>
<parameter name="ActionID" required="false"/>
@@ -308,6 +309,7 @@
</managerEvent>
<managerEvent language="en_US" name="FAXSessionsComplete">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>13.0.0</version></since>
<synopsis>Raised when all FAXSession events are completed for a FAXSessions command</synopsis>
<syntax>
<parameter name="ActionID" required="false"/>
@@ -339,6 +341,7 @@
</manager>
<managerEvent language="en_US" name="FAXSession">
<managerEventInstance class="EVENT_FLAG_REPORTING">
<since><version>13.0.0</version></since>
<synopsis>Raised in response to FAXSession manager command</synopsis>
<syntax>
<parameter name="ActionID" required="false"/>
@@ -407,6 +410,7 @@
</manager>
<managerEvent language="en_US" name="FAXStats">
<managerEventInstance class="EVENT_FLAG_REPORTING">
<since><version>13.0.0</version></since>
<synopsis>Raised in response to FAXStats manager command</synopsis>
<syntax>
<parameter name="ActionID" required="false"/>

1
res/res_manager_devicestate.c
View File

@@ -47,6 +47,7 @@
</list-elements>
<managerEvent name="DeviceStateListComplete" language="en_US">
<managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>13.0.0</version></since>
<synopsis>
Indicates the end of the list the current known extension states.
</synopsis>

1
res/res_manager_presencestate.c
View File

@@ -48,6 +48,7 @@
</list-elements>
<managerEvent name="PresenceStateListComplete" language="en_US">
<managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>13.0.0</version></since>
<synopsis>
Indicates the end of the list the current known extension states.
</synopsis>

2
res/res_mwi_external_ami.c
View File

@@ -54,6 +54,7 @@
</manager>
<managerEvent language="en_US" name="MWIGet">
<managerEventInstance class="EVENT_FLAG_REPORTING">
<since><version>12.1.0</version></since>
<synopsis>
Raised in response to a MWIGet command.
</synopsis>
@@ -76,6 +77,7 @@
</managerEvent>
<managerEvent language="en_US" name="MWIGetComplete">
<managerEventInstance class="EVENT_FLAG_REPORTING">
<since><version>12.1.0</version></since>
<synopsis>
Raised in response to a MWIGet command.
</synopsis>

15
res/res_pjsip/pjsip_manager.xml
View File

@@ -21,6 +21,7 @@
</manager>
<managerEvent language="en_US" name="IdentifyDetail">
<managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>13.20.0</version><version>15.3.0</version></since>
<synopsis>Provide details about an identify section.</synopsis>
<syntax>
<parameter name="ObjectType">
@@ -49,6 +50,7 @@
</managerEvent>
<managerEvent language="en_US" name="AorDetail">
<managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>13.12.0</version><version>14.1.0</version></since>
<synopsis>Provide details about an Address of Record (AoR) section.</synopsis>
<syntax>
<parameter name="ObjectType">
@@ -104,6 +106,7 @@
</managerEvent>
<managerEvent language="en_US" name="AuthDetail">
<managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>12.0.0</version></since>
<synopsis>Provide details about an authentication section.</synopsis>
<syntax>
<parameter name="ObjectType">
@@ -138,6 +141,7 @@
</managerEvent>
<managerEvent language="en_US" name="TransportDetail">
<managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>12.6.0</version></since>
<synopsis>Provide details about an authentication section.</synopsis>
<syntax>
<parameter name="ObjectType">
@@ -217,6 +221,7 @@
</managerEvent>
<managerEvent language="en_US" name="EndpointDetail">
<managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>12.0.0</version></since>
<synopsis>Provide details about an endpoint section.</synopsis>
<syntax>
<parameter name="ObjectType">
@@ -518,6 +523,7 @@
</managerEvent>
<managerEvent language="en_US" name="AorList">
<managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>16.0.0</version></since>
<synopsis>Provide details about an Address of Record (AoR) section.</synopsis>
<syntax>
<parameter name="ObjectType">
@@ -564,6 +570,7 @@
</managerEvent>
<managerEvent language="en_US" name="AuthList">
<managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>16.0.0</version></since>
<synopsis>Provide details about an Address of Record (Auth) section.</synopsis>
<syntax>
<parameter name="ObjectType">
@@ -595,6 +602,7 @@
</managerEvent>
<managerEvent language="en_US" name="ContactList">
<managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>16.0.0</version></since>
<synopsis>Provide details about a contact section.</synopsis>
<syntax>
<parameter name="ObjectType">
@@ -666,6 +674,7 @@
</managerEvent>
<managerEvent language="en_US" name="ContactStatusDetail">
<managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>13.0.0</version></since>
<synopsis>Provide details about a contact's status.</synopsis>
<syntax>
<parameter name="AOR">
@@ -727,6 +736,7 @@
</managerEvent>
<managerEvent language="en_US" name="EndpointList">
<managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>12.0.0</version></since>
<synopsis>Provide details about a contact's status.</synopsis>
<syntax>
<parameter name="ObjectType">
@@ -777,6 +787,7 @@
</list-elements>
<managerEvent language="en_US" name="EndpointListComplete">
<managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>12.0.0</version></since>
<synopsis>Provide final information about an endpoint list.</synopsis>
<syntax>
<parameter name="EventList"/>
@@ -821,6 +832,7 @@
</list-elements>
<managerEvent language="en_US" name="EndpointDetailComplete">
<managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>12.0.0</version></since>
<synopsis>Provide final information about endpoint details.</synopsis>
<syntax>
<parameter name="EventList"/>
@@ -851,6 +863,7 @@
</list-elements>
<managerEvent language="en_US" name="AorListComplete">
<managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>16.0.0</version></since>
<synopsis>Provide final information about an aor list.</synopsis>
<syntax>
<parameter name="EventList"/>
@@ -880,6 +893,7 @@
</list-elements>
<managerEvent language="en_US" name="AuthListComplete">
<managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>16.0.0</version></since>
<synopsis>Provide final information about an auth list.</synopsis>
<syntax>
<parameter name="EventList"/>
@@ -910,6 +924,7 @@
</list-elements>
<managerEvent language="en_US" name="ContactListComplete">
<managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>16.0.0</version></since>
<synopsis>Provide final information about a contact list.</synopsis>
<syntax>
<parameter name="EventList"/>