From: Leif Madsen <leif@leifmadsen.com>
Date: Mon, 3 Oct 2011 19:54:52 +0000 (+0000)
Subject: Make documentation for Dial() options 'F' and 'F()' more clear.
X-Git-Tag: 1.8.8.0-rc1~14
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e83a93313c042a9694420fb5d589f62a8d8d7467;p=thirdparty%2Fasterisk.git

Make documentation for Dial() options 'F' and 'F()' more clear.

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


git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/1.8@339144 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---

diff --git a/apps/app_dial.c b/apps/app_dial.c
index a9d1079a13..bd1794916e 100644
--- a/apps/app_dial.c
+++ b/apps/app_dial.c
@@ -152,12 +152,21 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 					<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