cvs: peardoc /en/package/authentication/auth/auth setsessionname.xml

aharvey		Mon Oct  1 05:03:32 2007 UTC

  Modified files:              
    /peardoc/en/package/authentication/auth/auth	setsessionname.xml 
  Log:
  Updated Auth::setSessionName() documentation to reflect what it actually does, per doc bug #12156.
  
  
http://cvs.php.net/viewvc.cgi/peardoc/en/package/authentication/auth/auth/setsessionname.xml?r1=1.3&r2=1.4&diff_format=u
Index: peardoc/en/package/authentication/auth/auth/setsessionname.xml
diff -u peardoc/en/package/authentication/auth/auth/setsessionname.xml:1.3 peardoc/en/package/authentication/auth/auth/setsessionname.xml:1.4
--- peardoc/en/package/authentication/auth/auth/setsessionname.xml:1.3	Mon Sep 11 02:11:21 2006
+++ peardoc/en/package/authentication/auth/auth/setsessionname.xml	Mon Oct  1 05:03:32 2007
@@ -1,8 +1,8 @@
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <refentry id="package.authentication.auth.auth.setsessionname">
    <refnamediv>
     <refname>Auth::setSessionName()</refname>
-    <refpurpose>set a custom session name</refpurpose>
+    <refpurpose>set a custom name for the Auth session variable</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
    <funcsynopsis>
@@ -15,9 +15,9 @@
    <refsect1 id="package.authentication.auth.auth.setsessionname.desc">
     &title.desc;
     <para>
-     This function can set a customized name for the session that is
-     created during the login process. The default for this session
-     name is "PHPSESSID". 
+     This function is used to set the name of the session variable used to
+     store the user's authentication details. The default for the session
+     variable name is <literal>_authsession</literal>.
     </para>
    </refsect1>   
    <refsect1 id="package.authentication.auth.auth.setsessionname.parameter">
@@ -31,7 +31,7 @@
        </term>
        <listitem>
         <para>        
-         the session name to use
+         the session variable name to use
         </para>
        </listitem>      
       </varlistentry>