From d24179825f768073a6e1db8369013388c207e16a Mon Sep 17 00:00:00 2001
From: "Eliel C. Sardanons" <eliels@gmail.com>
Date: Mon, 18 May 2009 14:45:23 +0000
Subject: Warn about the use of the application WaitExten() within a Macro().

Update applications documentation to warn the user about the use of the
WaitExten() application within a Macro(). Recommend the use of Read()
instead.

(closes issue #14444)
Reported by: ewieling


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@195162 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---
 apps/app_dial.c  | 3 +++
 apps/app_macro.c | 5 +++++
 main/pbx.c       | 1 +
 3 files changed, 9 insertions(+)

diff --git a/apps/app_dial.c b/apps/app_dial.c
index 7364a4605..fb14ac0c5 100644
--- a/apps/app_dial.c
+++ b/apps/app_dial.c
@@ -258,6 +258,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 						with this option. Also, pbx services are not run on the peer (called) channel,
 						so you will not be able to set timeouts via the TIMEOUT() function in this macro.</para>
 					</note>
+					<warning><para>Be aware of the limitations that macros have, specifically with regards to use of
+					the <literal>WaitExten</literal> application. For more information, see the documentation for
+					Macro()</para></warning>
 				</option>
 				<option name="n">
 					<para>This option is a modifier for the call screening/privacy mode. (See the 
diff --git a/apps/app_macro.c b/apps/app_macro.c
index 458a93b37..19cc04ff6 100644
--- a/apps/app_macro.c
+++ b/apps/app_macro.c
@@ -68,6 +68,9 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 			applications in deeply nested macros could cause asterisk to crash earlier than this limit.
 			It is advised that if you need to deeply nest macro calls, that you use the Gosub application
 			(now allows arguments like a Macro) with explict Return() calls instead.</para></warning>
+			<warning><para>Use of the application <literal>WaitExten</literal> within a macro will not function
+			as expected. Please use the <literal>Read</literal> application in order to read DTMF from a channel
+			currently executing a macro.</para></warning>
 		</description>
 		<see-also>
 			<ref type="application">MacroExit</ref>
@@ -97,6 +100,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 			<replaceable>expr</replaceable> is true (otherwise <replaceable>macroiffalse</replaceable>
 			if provided)</para>
 			<para>Arguments and return values as in application Macro()</para>
+			<xi:include xpointer="xpointer(/docs/application[@name='Macro']/description/warning[2])" />
 		</description>
 		<see-also>
 			<ref type="application">GotoIf</ref>
@@ -120,6 +124,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 			Only one call at a time may run the macro. (we'll wait if another call is busy
 			executing in the Macro)</para>
 			<para>Arguments and return values as in application Macro()</para>
+			<xi:include xpointer="xpointer(/docs/application[@name='Macro']/description/warning[2])" />
 		</description>
 		<see-also>
 			<ref type="application">Macro</ref>
diff --git a/main/pbx.c b/main/pbx.c
index e01877135..28c04802d 100644
--- a/main/pbx.c
+++ b/main/pbx.c
@@ -679,6 +679,7 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 		<description>
 			<para>This application waits for the user to enter a new extension for a specified number
 			of <replaceable>seconds</replaceable>.</para>
+			<xi:include xpointer="xpointer(/docs/application[@name='Macro']/description/warning[2])" />
 		</description>
 		<see-also>
 			<ref type="application">Background</ref>
-- 
cgit v1.2.3