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 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 a47b8e2d40)
This commit is contained in:
George Joseph
2025-01-20 11:33:20 -07:00
committed by Asterisk Development Team
parent 605e6dc33c
commit 8c07517a6f
45 changed files with 197 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
main/manager_channels.c
View File

@@ -38,6 +38,7 @@
/*** DOCUMENTATION
<managerEvent language="en_US" name="Newchannel">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a new channel is created.</synopsis>
<syntax>
<channel_snapshot/>
@@ -50,6 +51,7 @@
</managerEvent>
<managerEvent language="en_US" name="Newstate">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel's state changes.</synopsis>
<syntax>
<channel_snapshot/>
@@ -62,6 +64,7 @@
</managerEvent>
<managerEvent language="en_US" name="Hangup">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel is hung up.</synopsis>
<syntax>
<channel_snapshot/>
@@ -82,6 +85,7 @@
</managerEvent>
<managerEvent language="en_US" name="HangupRequest">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a hangup is requested.</synopsis>
<syntax>
<channel_snapshot/>
@@ -95,6 +99,7 @@
</managerEvent>
<managerEvent language="en_US" name="SoftHangupRequest">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a soft hangup is requested with a specific cause code.</synopsis>
<syntax>
<channel_snapshot/>
@@ -108,6 +113,7 @@
</managerEvent>
<managerEvent language="en_US" name="NewExten">
<managerEventInstance class="EVENT_FLAG_DIALPLAN">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel enters a new context, extension, priority.</synopsis>
<syntax>
<channel_snapshot/>
@@ -127,6 +133,7 @@
</managerEvent>
<managerEvent language="en_US" name="NewCallerid">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel receives new Caller ID information.</synopsis>
<syntax>
<channel_snapshot/>
@@ -141,6 +148,7 @@
</managerEvent>
<managerEvent language="en_US" name="NewConnectedLine">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>13.13.0</version><version>14.2.0</version></since>
<synopsis>Raised when a channel's connected line information is changed.</synopsis>
<syntax>
<channel_snapshot/>
@@ -152,6 +160,7 @@
</managerEvent>
<managerEvent language="en_US" name="NewAccountCode">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a Channel's AccountCode is changed.</synopsis>
<syntax>
<channel_snapshot/>
@@ -166,6 +175,7 @@
</managerEvent>
<managerEvent language="en_US" name="DialBegin">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a dial action has started.</synopsis>
<syntax>
<channel_snapshot/>
@@ -184,6 +194,7 @@
</managerEvent>
<managerEvent language="en_US" name="DialState">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>14.0.0</version></since>
<synopsis>Raised when dial status has changed.</synopsis>
<syntax>
<channel_snapshot/>
@@ -211,6 +222,7 @@
</managerEvent>
<managerEvent language="en_US" name="DialEnd">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a dial action has completed.</synopsis>
<syntax>
<channel_snapshot/>
@@ -267,6 +279,7 @@
</managerEvent>
<managerEvent language="en_US" name="Hold">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel goes on hold.</synopsis>
<syntax>
<channel_snapshot/>
@@ -281,6 +294,7 @@
</managerEvent>
<managerEvent language="en_US" name="Unhold">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel goes off hold.</synopsis>
<syntax>
<channel_snapshot/>
@@ -292,6 +306,7 @@
</managerEvent>
<managerEvent language="en_US" name="ChanSpyStart">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when one channel begins spying on another channel.</synopsis>
<syntax>
<channel_snapshot prefix="Spyer"/>
@@ -305,6 +320,7 @@
</managerEvent>
<managerEvent language="en_US" name="ChanSpyStop">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel has stopped spying.</synopsis>
<syntax>
<channel_snapshot prefix="Spyer"/>
@@ -318,6 +334,7 @@
</managerEvent>
<managerEvent language="en_US" name="HangupHandlerRun">
<managerEventInstance class="EVENT_FLAG_DIALPLAN">
<since><version>12.0.0</version></since>
<synopsis>Raised when a hangup handler is about to be called.</synopsis>
<syntax>
<channel_snapshot/>
@@ -332,6 +349,7 @@
</managerEvent>
<managerEvent language="en_US" name="HangupHandlerPop">
<managerEventInstance class="EVENT_FLAG_DIALPLAN">
<since><version>12.0.0</version></since>
<synopsis>
Raised when a hangup handler is removed from the handler stack
by the CHANNEL() function.
@@ -348,6 +366,7 @@
</managerEvent>
<managerEvent language="en_US" name="HangupHandlerPush">
<managerEventInstance class="EVENT_FLAG_DIALPLAN">
<since><version>12.0.0</version></since>
<synopsis>
Raised when a hangup handler is added to the handler stack by
the CHANNEL() function.
@@ -364,6 +383,7 @@
</managerEvent>
<managerEvent language="en_US" name="FAXStatus">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>
Raised periodically during a fax transmission.
</synopsis>
@@ -386,6 +406,7 @@
</managerEvent>
<managerEvent language="en_US" name="ReceiveFAX">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>
Raised when a receive fax operation has completed.
</synopsis>
@@ -414,6 +435,7 @@
</managerEvent>
<managerEvent language="en_US" name="SendFAX">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>
Raised when a send fax operation has completed.
</synopsis>
@@ -425,6 +447,7 @@
</managerEvent>
<managerEvent language="en_US" name="MusicOnHoldStart">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when music on hold has started on a channel.</synopsis>
<syntax>
<channel_snapshot/>
@@ -441,6 +464,7 @@
</managerEvent>
<managerEvent language="en_US" name="MusicOnHoldStop">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when music on hold has stopped on a channel.</synopsis>
<syntax>
<channel_snapshot/>
@@ -871,6 +895,7 @@ static void channel_dtmf_begin_cb(void *data, struct stasis_subscription *sub,
/*** DOCUMENTATION
<managerEvent language="en_US" name="DTMFBegin">
<managerEventInstance class="EVENT_FLAG_DTMF">
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
<synopsis>Raised when a DTMF digit has started on a channel.</synopsis>
<syntax>
<channel_snapshot/>
@@ -919,6 +944,7 @@ static void channel_dtmf_end_cb(void *data, struct stasis_subscription *sub,
/*** DOCUMENTATION
<managerEvent language="en_US" name="DTMFEnd">
<managerEventInstance class="EVENT_FLAG_DTMF">
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
<synopsis>Raised when a DTMF digit has ended on a channel.</synopsis>
<syntax>
<channel_snapshot/>
@@ -964,6 +990,7 @@ static void channel_flash_cb(void *data, struct stasis_subscription *sub,
/*** DOCUMENTATION
<managerEvent language="en_US" name="Flash">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
<synopsis>Raised when a hook flash occurs on a channel.</synopsis>
<syntax>
<channel_snapshot/>
@@ -992,6 +1019,7 @@ static void channel_wink_cb(void *data, struct stasis_subscription *sub,
/*** DOCUMENTATION
<managerEvent language="en_US" name="Wink">
<managerEventInstance class="EVENT_FLAG_CALL">
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
<synopsis>Raised when a wink occurs on a channel.</synopsis>
<syntax>
<channel_snapshot/>