From 7d647f243cde70f3ef88fcba685fc8377fb80346 Mon Sep 17 00:00:00 2001
From: Nuno Lopes <nlopess@php.net>
Date: Tue, 6 Jun 2006 11:31:44 +0000
Subject: [PATCH] add new docs for memory_get_peak_usage()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@214306 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../info/functions/memory-get-peak-usage.xml  | 56 +++++++++++++++++++
 reference/info/functions/memory-get-usage.xml |  4 +-
 2 files changed, 58 insertions(+), 2 deletions(-)
 create mode 100644 reference/info/functions/memory-get-peak-usage.xml

diff --git a/reference/info/functions/memory-get-peak-usage.xml b/reference/info/functions/memory-get-peak-usage.xml
new file mode 100644
index 0000000000..e60c62e000
--- /dev/null
+++ b/reference/info/functions/memory-get-peak-usage.xml
@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<refentry id="function.memory-get-peak-usage">
+ <refnamediv>
+  <refname>memory_get_peak_usage</refname>
+  <refpurpose>Returns the peak of memory allocated by PHP</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>int</type><methodname>memory_get_peak_usage</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Returns the peak of memory, in bytes, that's been allocated to your PHP
+   script.
+  </para>
+  <para>
+   <function>memory_get_usage</function> will only be defined if your PHP
+   is compiled with the <literal>--enable-memory-limit</literal> 
+   configuration option.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>memory_get_usage</function></member>
+    <member><link linkend="ini.memory-limit">memory_limit</link></member>
+   </simplelist>
+  </para>
+ </refsect1>
+</refentry>
+
+<!-- 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
+-->
diff --git a/reference/info/functions/memory-get-usage.xml b/reference/info/functions/memory-get-usage.xml
index f1e9b79935..e2847247e1 100644
--- a/reference/info/functions/memory-get-usage.xml
+++ b/reference/info/functions/memory-get-usage.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
   <refentry id="function.memory-get-usage">
    <refnamediv>
     <refname>memory_get_usage</refname>
@@ -45,7 +45,7 @@ echo memory_get_usage() . "\n"; // 36744
      </example>
     </para>
     <para>
-     See also 
+     See also <function>memory_get_peak_usage</function> and
      <link linkend="ini.memory-limit">memory_limit</link>.
     </para>
    </refsect1>