php-doc-en/reference/memtrack/ini.xml
2009-02-13 10:46:14 +00:00

165 lines
4.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<section xml:id="memtrack.ini" xmlns="http://docbook.org/ns/docbook">
&reftitle.runtime;
&extension.runtime;
<para>
<table>
<title>Memtrack Configuration Options</title>
<tgroup cols="3">
<thead>
<row>
<entry>Name</entry>
<entry>Default</entry>
<entry>Changeable</entry>
</row>
</thead>
<tbody>
<row>
<entry>memtrack.enabled</entry>
<entry>"0"</entry>
<entry>PHP_INI_SYSTEM</entry>
</row>
<row>
<entry>memtrack.soft_limit</entry>
<entry>"0"</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>memtrack.hard_limit</entry>
<entry>"0"</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>memtrack.vm_limit</entry>
<entry>"0"</entry>
<entry>PHP_INI_ALL</entry>
</row>
<row>
<entry>memtrack.ignore_functions</entry>
<entry>""</entry>
<entry>PHP_INI_SYSTEM</entry>
</row>
</tbody>
</tgroup>
</table>
&ini.php.constants;
</para>
&ini.descriptions.title;
<para>
<variablelist>
<varlistentry xml:id="ini.memtrack.enabled">
<term>
<parameter>memtrack.enabled</parameter>
<type>boolean</type>
</term>
<listitem>
<para>
Disables or enables the extension. Default value is 0, i.e. disabled.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memtrack.soft_limit">
<term>
<parameter>memtrack.soft_limit</parameter>
<type>int</type>
</term>
<listitem>
<para>
Soft memory limit.
</para>
<para>
The extension checks memory consumption before and after executing an
op_array and produces a warning is the difference between the two values
is equal to or greater than the soft limit, but only if the function is not
ignored.
</para>
<para>
Setting this option to 0 also disables both soft and hard limit warnings.
Default value is 0, i.e. no warnings is produced.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memtrack.hard_limit">
<term>
<parameter>memtrack.hard_limit</parameter>
<type>int</type>
</term>
<listitem>
<para>
Hard memory limit.
</para>
<para>
The extension checks memory consumption before and after executing an
op_array and produces a warning is the difference between the two values
is equal to or greater than the hard limit, <emphasis>even if the function is
ignored</emphasis>.
Setting this option to 0 disables hard limit warnings completely.
Default value is 0, i.e. no hard limit warnings is produced.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memtrack.vm_limit">
<term>
<parameter>memtrack.vm_limit</parameter>
<type>int</type>
</term>
<listitem>
<para>
Virtual memory limit (set on a process).
</para>
<para>
This limit is checked only on shutdown and a warning is produced if the
value is greater than or equal to the limit.
</para>
<para>
This option is currently supported only on OSes where mallinfo() function
is available (i.e. Linux).
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.memtrack.ignore_functions">
<term>
<parameter>memtrack.ignore_functions</parameter>
<type>string</type>
</term>
<listitem>
<para>
A comma or whitespace-separated list of functions which are to be ignored
by soft_limit. The values are case-insensitive, for class methods use
class::method syntax.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->