kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-24 22:58:21 +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.
This commit is contained in:
George Joseph
2025-01-20 11:33:20 -07:00
parent ac559b236d
commit a47b8e2d40
45 changed files with 197 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
apps/app_queue.c
View File

@@ -1134,6 +1134,7 @@
<managerEvent language="en_US" name="QueueParams">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
<synopsis>Raised in response to the QueueStatus action.</synopsis>
<syntax>
<parameter name="Max">
@@ -1172,6 +1173,7 @@
</managerEvent>
<managerEvent language="en_US" name="QueueEntry">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
<synopsis>Raised in response to the QueueStatus action.</synopsis>
<syntax>
<parameter name="Queue">
@@ -1213,6 +1215,7 @@
</managerEvent>
<managerEvent language="en_US" name="QueueMemberStatus">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a Queue member's status has changed.</synopsis>
<syntax>
<parameter name="Queue">
@@ -1293,6 +1296,7 @@
</managerEvent>
<managerEvent language="en_US" name="QueueMemberAdded">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a member is added to the queue.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@@ -1305,6 +1309,7 @@
</managerEvent>
<managerEvent language="en_US" name="QueueMemberRemoved">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a member is removed from the queue.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@@ -1317,6 +1322,7 @@
</managerEvent>
<managerEvent language="en_US" name="QueueMemberPause">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.2.0</version></since>
<synopsis>Raised when a member is paused/unpaused in the queue.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@@ -1329,6 +1335,7 @@
</managerEvent>
<managerEvent language="en_US" name="QueueMemberPenalty">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a member's penalty is changed.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@@ -1340,6 +1347,7 @@
</managerEvent>
<managerEvent language="en_US" name="QueueMemberRinginuse">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a member's ringinuse setting is changed.</synopsis>
<syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@@ -1351,6 +1359,7 @@
</managerEvent>
<managerEvent language="en_US" name="QueueCallerJoin">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a caller joins a Queue.</synopsis>
<syntax>
<channel_snapshot/>
@@ -1370,6 +1379,7 @@
</managerEvent>
<managerEvent language="en_US" name="QueueCallerLeave">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a caller leaves a Queue.</synopsis>
<syntax>
<channel_snapshot/>
@@ -1384,6 +1394,7 @@
</managerEvent>
<managerEvent language="en_US" name="QueueCallerAbandon">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a caller abandons the queue.</synopsis>
<syntax>
<channel_snapshot/>
@@ -1400,6 +1411,7 @@
</managerEvent>
<managerEvent language="en_US" name="AgentCalled">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when an queue member is notified of a caller in the queue.</synopsis>
<syntax>
<channel_snapshot/>
@@ -1417,6 +1429,7 @@
</managerEvent>
<managerEvent language="en_US" name="AgentRingNoAnswer">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a queue member is notified of a caller in the queue and fails to answer.</synopsis>
<syntax>
<channel_snapshot/>
@@ -1435,6 +1448,7 @@
</managerEvent>
<managerEvent language="en_US" name="AgentComplete">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a queue member has finished servicing a caller in the queue.</synopsis>
<syntax>
<channel_snapshot/>
@@ -1462,6 +1476,7 @@
</managerEvent>
<managerEvent language="en_US" name="AgentDump">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a queue member hangs up on a caller in the queue.</synopsis>
<syntax>
<channel_snapshot/>
@@ -1478,6 +1493,7 @@
</managerEvent>
<managerEvent language="en_US" name="AgentConnect">
<managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a queue member answers and is bridged to a caller in the queue.</synopsis>
<syntax>
<channel_snapshot/>