Clarify documentation for the "identify_by" option for SIP endpoints.
authorMark Michelson <mmichelson@digium.com>
Tue, 20 Aug 2013 15:39:38 +0000 (15:39 +0000)
committerMark Michelson <mmichelson@digium.com>
Tue, 20 Aug 2013 15:39:38 +0000 (15:39 +0000)
This also removes documentation for the options that no longer exist.

(closes issue ASTERISK-22306)
reported by Rusty Newton

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

res/res_pjsip.c

index 6879858..d2ce7f2 100644 (file)
                                <configOption name="identify_by" default="username,location">
                                        <synopsis>Way(s) for Endpoint to be identified</synopsis>
                                        <description><para>
-                                               There are currently two methods to identify an endpoint. By default
-                                               both are used to identify an endpoint.
+                                               An endpoint can be identified in multiple ways. Currently, the only supported
+                                               option is <literal>username</literal>, which matches the endpoint based on the
+                                               username in the From header.
                                                </para>
+                                               <note><para>Endpoints can also be identified by IP address; however, that method
+                                               of identification is not handled by this configuration option. See the documentation
+                                               for the <literal>identify</literal> configuration section for more details on that
+                                               method of endpoint identification. If this option is set to <literal>username</literal>
+                                               and an <literal>identify</literal> configuration section exists for the endpoint, then
+                                               the endpoint can be identified in multiple ways.</para></note>
                                                <enumlist>
                                                        <enum name="username" />
-                                                       <enum name="location" />
-                                                       <enum name="username,location" />
                                                </enumlist>
                                        </description>
                                </configOption>