[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] [doc-en] master: Remove memtrack docs
From: George Peter Banyard <noreply () php ! net>
Date: 2021-05-25 18:40:37
Message-ID: EgQK1VwHJlA6kKHUDZKpvDt0s7o6vHVrCpdXrISPuls () main ! php ! net
[Download RAW message or body]
Author: George Peter Banyard (Girgias)
Date: 2021-05-25T19:38:26+01:00
Commit: https://github.com/php/doc-en/commit/6d1284c431c26d71619813a18c15896e88262157
Raw diff: https://github.com/php/doc-en/commit/6d1284c431c26d71619813a18c15896e88262157.diff
Remove memtrack docs
Changed paths:
D reference/memtrack/book.xml
D reference/memtrack/configure.xml
D reference/memtrack/constants.xml
D reference/memtrack/examples.xml
D reference/memtrack/ini.xml
D reference/memtrack/setup.xml
M appendices/extensions.xml
Diff:
diff --git a/appendices/extensions.xml b/appendices/extensions.xml
index 04ba4b4d3f..0a5e3a2886 100644
--- a/appendices/extensions.xml
+++ b/appendices/extensions.xml
@@ -79,7 +79,6 @@
<listitem><simpara><xref linkend="book.mcrypt"/></simpara></listitem>
<listitem><simpara><xref linkend="book.memcache"/></simpara></listitem>
<listitem><simpara><xref linkend="book.memcached"/></simpara></listitem>
- <listitem><simpara><xref linkend="book.memtrack"/></simpara></listitem>
<listitem><simpara><xref linkend="book.mhash"/></simpara></listitem>
<listitem><simpara><xref linkend="book.misc"/></simpara></listitem>
<listitem><simpara><xref linkend="book.mongo"/></simpara></listitem>
@@ -340,7 +339,6 @@
<listitem><para><xref linkend="book.mailparse"/></para></listitem>
<listitem><para><xref linkend="book.memcache"/></para></listitem>
<listitem><para><xref linkend="book.memcached"/></para></listitem>
- <listitem><para><xref linkend="book.memtrack"/></para></listitem>
<listitem><para><xref linkend="book.mongo"/></para></listitem>
<listitem><para><xref linkend="book.mqseries"/></para></listitem>
<listitem><para><xref linkend="book.mysqlnd-memcache"/></para></listitem>
@@ -397,15 +395,15 @@
<section xml:id="extensions.state">
&extcat.state;
-
+ <!--
<section xml:id="extensions.state.deprecated">
&extcat.state.deprecated;
<itemizedlist>
- <listitem><para><xref linkend="book.memtrack"/></para></listitem>
+ <listitem><para></para></listitem>
</itemizedlist>
</section>
-
+ -->
<section xml:id="extensions.state.experimental">
&extcat.state.experimental;
diff --git a/reference/memtrack/book.xml b/reference/memtrack/book.xml
deleted file mode 100644
index fde85dbd67..0000000000
--- a/reference/memtrack/book.xml
+++ /dev/null
@@ -1,61 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision$ -->
-<!-- State: deprecated -->
-
-<book xml:id="book.memtrack" xmlns="http://docbook.org/ns/docbook">
- <title>Memtrack</title>
- <titleabbrev>Memtrack</titleabbrev>
-
- <preface xml:id="intro.memtrack">
- &reftitle.intro;
- <para>
- The purpose of this extension is to detect the most memory hungry scripts
- and functions.
- </para>
- <para>
- memtrack tracks memory consumption in PHP scripts and produces reports
- (warnings) when the consumption reaches certain levels set by the user.
- This is achieved by replacing default executor function by a special
- function which compares memory usage before and after running the
- original executor - this way we can tell how much the memory usage
- has changed during the execution of the current part of the code.
- </para>
- <para>
- Zend Engine runs its executor for each opcode array (op_array),
- which usually means function, plain script and such, so memtrack doesn't
- have any noticeable effect on performance.
- </para>
- <para>
- memtrack doesn't provide any functions, there are only INI directives which
- allow you to configure the way it should work.
- </para>
- &warn.experimental;
- </preface>
-
- &reference.memtrack.setup;
- &reference.memtrack.constants;
- &reference.memtrack.examples;
-
-</book>
-
-<!-- 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:"~/.phpdoc/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
--->
-
diff --git a/reference/memtrack/configure.xml b/reference/memtrack/configure.xml
deleted file mode 100644
index 381b63b4cf..0000000000
--- a/reference/memtrack/configure.xml
+++ /dev/null
@@ -1,32 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision$ -->
-
-<section xml:id="memtrack.installation" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink">
- &reftitle.install;
- <para>
- &pecl.info;
- <link xlink:href="&url.pecl.package;memtrack">&url.pecl.package;memtrack</link>
- </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:"~/.phpdoc/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
--->
-
diff --git a/reference/memtrack/constants.xml b/reference/memtrack/constants.xml
deleted file mode 100644
index 0e3fe845dd..0000000000
--- a/reference/memtrack/constants.xml
+++ /dev/null
@@ -1,29 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision$ -->
-
-<appendix xml:id="memtrack.constants" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink">
- &reftitle.constants;
- &no.constants;
-</appendix>
-
-<!-- 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:"~/.phpdoc/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
--->
-
diff --git a/reference/memtrack/examples.xml b/reference/memtrack/examples.xml
deleted file mode 100644
index 2fd7b40260..0000000000
--- a/reference/memtrack/examples.xml
+++ /dev/null
@@ -1,68 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision$ -->
-
-<appendix xml:id="memtrack.examples" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink">
- &reftitle.examples;
- <section xml:id="memtrack.examples.basic">
- <title>Basic usage</title>
- <para>
- Basic example on using memtrack extension:
- <example>
- <title>Creating large array in a function</title>
- <programlisting role="php">
-<![CDATA[
-<?php
-
-/* /tmp/example1.php */
-
-function foo() {
- $a = array();
- for ($i = 0; $i < 10000; $i++) $a[] = "test";
- return $a;
-}
-$arr = foo();
-
-?>
-]]>
- </programlisting>
- </example>
- </para>
- <para>
- Run the example with the following command:
- </para>
- <screen>
-<![CDATA[
-php -d memtrack.enabled=1 -d memtrack.soft_limit=1M -d memtrack.vm_limit=3M \
/tmp/example1.php
-]]>
- </screen>
- &example.outputs.similar;
- <screen>
-<![CDATA[
-Warning: [memtrack] [pid 26177] user function foo() executed in /tmp/example1.php on \
line 10 allocated 4194304 bytes in /tmp/example1.php on line 0
-Warning: [memtrack] [pid 26177] virtual memory usage on shutdown: 32911360 bytes in \
Unknown on line 0
-]]>
- </screen>
- </section>
-</appendix>
-
-<!-- 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:"~/.phpdoc/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
--->
-
diff --git a/reference/memtrack/ini.xml b/reference/memtrack/ini.xml
deleted file mode 100644
index 26efe63a4f..0000000000
--- a/reference/memtrack/ini.xml
+++ /dev/null
@@ -1,165 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision$ -->
-<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><link linkend="ini.memtrack.enabled">memtrack.enabled</link></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>bool</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:"~/.phpdoc/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
--->
diff --git a/reference/memtrack/setup.xml b/reference/memtrack/setup.xml
deleted file mode 100644
index 1af2b7a61d..0000000000
--- a/reference/memtrack/setup.xml
+++ /dev/null
@@ -1,43 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision$ -->
-
-<chapter xml:id="memtrack.setup" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink">
- &reftitle.setup;
-
- <section xml:id="memtrack.requirements">
- &reftitle.required;
- &no.requirement;
- </section>
-
- &reference.memtrack.configure;
-
- &reference.memtrack.ini;
-
- <section xml:id="memtrack.resources">
- &reftitle.resources;
- &no.resource;
- </section>
-
-</chapter>
-
-<!-- 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:"~/.phpdoc/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
--->
-
--
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic