Properly document session.save_path's N parameter. This closes bug #22476

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@126984 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Philip Olson 2003-05-14 14:19:03 +00:00
parent 24e1656b7c
commit 993d188d44

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.12 $ -->
<!-- $Revision: 1.13 $ -->
<section id="session.configuration">
&reftitle.runtime;
&extension.runtime;
@ -161,12 +161,27 @@
<simpara>
<literal>session.save_path</literal> defines the argument which
is passed to the save handler. If you choose the default files
handler, this is the path where the files are created.
Defaults to <literal>/tmp</literal>. If
<literal>session.save_path</literal>'s path depth is more than
2, garbage collection will not be performed. See also
<function>session_save_path</function>.
handler, this is the path where the files are created. Defaults to
<literal>/tmp</literal>. See also
<function>session_save_path</function>.
</simpara>
<para>
There is an optional N argument to this directive that determines
the number of directory levels your session files will be spread
around in. For example, setting to <literal>'5;/tmp'</literal>
may end up creating a session file and location like
<literal>/tmp/4/b/1/e/3/sess_4b1e384ad74619bd212e236e52a5a174If
</literal>. In order to use N you must create all of these
directories before use. A small shell script exists in
<filename>ext/session</filename> to do this, it's called
<filename>mod_files.sh</filename>. Also note that if N is
used and greater than 0 then automatic garbage collection will
not be performed, see a copy of &php.ini; for further
information. Also, if you use N, be sure to surround
<literal>session.save_path</literal> in
"quotes" because the separator (<literal>;</literal>) is
also used for comments in &php.ini;.
</para>
<warning>
<para>
If you leave this set to a world-readable directory, such as