Update Pickup application documentation. (With feeling this time.)
authorRichard Mudgett <rmudgett@digium.com>
Thu, 26 Apr 2012 21:11:25 +0000 (21:11 +0000)
committerRichard Mudgett <rmudgett@digium.com>
Thu, 26 Apr 2012 21:11:25 +0000 (21:11 +0000)
........

Merged revisions 364108 from http://svn.asterisk.org/svn/asterisk/branches/1.8
........

Merged revisions 364109 from http://svn.asterisk.org/svn/asterisk/branches/10

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

apps/app_directed_pickup.c

index 5d037e7..77a6e46 100644 (file)
@@ -78,14 +78,19 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
                        <para>2) If the <replaceable>extension</replaceable> is specified with a
                        <replaceable>context</replaceable> of the special string
                        <literal>PICKUPMARK</literal> (for example 10@PICKUPMARK), the application
-                       will pickup a channel which has defined a channel variable
+                       will pickup a channel which has defined the channel variable
                        <variable>PICKUPMARK</variable> with the same value as
                        <replaceable>extension</replaceable> (in this example,
                        <literal>10</literal>).</para>
                        <para>3) If the <replaceable>extension</replaceable> is specified
-                       with a <replaceable>context</replaceable>, the channel executing at that
-                       dialplan location will be picked up.  If no <replaceable>context</replaceable>
-                       is specified, the current context will be used.</para>
+                       with or without a <replaceable>context</replaceable>, the channel with a
+                       matching <replaceable>extension</replaceable> and <replaceable>context</replaceable>
+                       will be picked up.  If no <replaceable>context</replaceable> is specified,
+                       the current context will be used.</para>
+                       <note><para>The <replaceable>extension</replaceable> is typically set on
+                       matching channels by the dial application that created the channel.  The
+                       <replaceable>context</replaceable> is set on matching channels by the
+                       channel driver for the device.</para></note>
                </description>
        </application>
        <application name="PickupChan" language="en_US">