[svn-commits] newtonr: trunk r396900 - /trunk/res/res_pjsip.c

[SVN commits to the Digium repositories]

Author: newtonr
Date: Sat Aug 17 12:40:34 2013
New Revision: 396900

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=396900
Log:
xml doc changes for clarity - 'auth' config object and auth's 'auth_type' config option

(issue ASTERISK-22108)
(closes issue ASTERISK-22108)

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=396900&r1=396899&r2=396900
==============================================================================
--- trunk/res/res_pjsip.c (original)
+++ trunk/res/res_pjsip.c Sat Aug 17 12:40:34 2013
@@ -623,16 +623,18 @@
 			<configObject name="auth">
 				<synopsis>Authentication type</synopsis>
 				<description><para>
-					Authentication objects hold the authenitcation information for use
-					by <literal>endpoints</literal>. This also allows for multiple <literal>
-					endpoints</literal> to use the same information. Choice of MD5/plaintext
-					and setting of username.
+					Authentication objects hold the authentication information for use
+					by other objects such as <literal>endpoints</literal> or <literal>registrations</literal>.
+					This also allows for multiple objects to use a single auth object. See
+					the <literal>auth_type</literal> config option for password style choices.
 				</para></description>
 				<configOption name="auth_type" default="userpass">
 					<synopsis>Authentication type</synopsis>
 					<description><para>
-						This option specifies which of the password style config options should be read,
-						either 'password' or 'md5_cred' when trying to authenticate an endpoint inbound request.
+						This option specifies which of the password style config options should be read
+						when trying to authenticate an endpoint inbound request. If set to <literal>userpass</literal>
+						then we'll read from the 'password' option. For <literal>md5</literal> we'll read
+						from 'md5_cred'.
 						</para>
 						<enumlist>
 							<enum name="md5"/>