[asterisk-commits] mmichelson: trunk r397111 - /trunk/res/res_pjsip.c

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Tue Aug 20 10:39:38 2013
New Revision: 397111

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=397111
Log:
Clarify documentation for the "identify_by" option for SIP endpoints.

This also removes documentation for the options that no longer exist.


Modified:
    trunk/res/res_pjsip.c

Modified: trunk/res/res_pjsip.c
URL: http://svnview.digium.com/svn/asterisk/trunk/res/res_pjsip.c?view=diff&rev=397111&r1=397110&r2=397111
==============================================================================
--- trunk/res/res_pjsip.c (original)
+++ trunk/res/res_pjsip.c Tue Aug 20 10:39:38 2013
@@ -220,13 +220,18 @@
 				<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>