[asterisk-commits] lmadsen: branch 1.8 r339144 - /branches/1.8/apps/app_dial.c

[SVN commits to the Asterisk project]

Author: lmadsen
Date: Mon Oct  3 14:54:52 2011
New Revision: 339144

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=339144
Log:
Make documentation for Dial() options 'F' and 'F()' more clear.

(Closes issue ASTERISK-18646)
Reported by: Physis Heckman
Tested by: Richard Mudgett

Modified:
    branches/1.8/apps/app_dial.c

Modified: branches/1.8/apps/app_dial.c
URL: http://svnview.digium.com/svn/asterisk/branches/1.8/apps/app_dial.c?view=diff&rev=339144&r1=339143&r2=339144
==============================================================================
--- branches/1.8/apps/app_dial.c (original)
+++ branches/1.8/apps/app_dial.c Mon Oct  3 14:54:52 2011
@@ -152,12 +152,21 @@
 					<argument name="context" required="false" />
 					<argument name="exten" required="false" />
 					<argument name="priority" required="true" />
-					<para>When the caller hangs up, transfer the called party
-					to the specified destination and continue execution at that location.</para>
+					<para>When the caller hangs up, transfer the <emphasis>called</emphasis> party
+					to the specified destination and <emphasis>start</emphasis> execution at that location.</para>
+					<note>
+						<para>Any channel variables you want the called channel to inherit from the caller channel must be
+						prefixed with one or two underbars ('_').</para>
+					</note>
 				</option>
 				<option name="F">
-					<para>Proceed with dialplan execution at the next priority in the current extension if the
-					source channel hangs up.</para>
+					<para>When the caller hangs up, transfer the <emphasis>called</emphasis> party to the next priority of the current extension
+					and <emphasis>start</emphasis> execution at that location.</para>
+					<note>
+						<para>Any channel variables you want the called channel to inherit from the caller channel must be
+						prefixed with one or two underbars ('_').</para>
+						<para>Additionally, using this option from a Macro() or GoSub() might not make sense as there would be no return points</para>
+					</note>
 				</option>
 				<option name="g">
 					<para>Proceed with dialplan execution at the next priority in the current extension if the