From 2a69ff3bdb198b3beb87634bff67434a622d80ed Mon Sep 17 00:00:00 2001
From: Jakub Vrana <vrana@php.net>
Date: Wed, 7 Jan 2009 17:01:35 +0000
Subject: [PATCH] Document GC

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@272976 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../info/functions/gc-collect-cycles.xml      | 130 ++++++++++++++++++
 reference/info/functions/gc-disable.xml       | 130 ++++++++++++++++++
 reference/info/functions/gc-enable.xml        | 130 ++++++++++++++++++
 reference/info/functions/gc-enabled.xml       | 130 ++++++++++++++++++
 reference/info/ini.xml                        |  20 ++-
 5 files changed, 539 insertions(+), 1 deletion(-)
 create mode 100644 reference/info/functions/gc-collect-cycles.xml
 create mode 100644 reference/info/functions/gc-disable.xml
 create mode 100644 reference/info/functions/gc-enable.xml
 create mode 100644 reference/info/functions/gc-enabled.xml

diff --git a/reference/info/functions/gc-collect-cycles.xml b/reference/info/functions/gc-collect-cycles.xml
new file mode 100644
index 0000000000..80aced35cc
--- /dev/null
+++ b/reference/info/functions/gc-collect-cycles.xml
@@ -0,0 +1,130 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+<refentry xml:id="function.gc-collect-cycles" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>gc_collect_cycles</refname>
+  <refpurpose>Forces collection of any existing garbage cycles</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>int</type><methodname>gc_collect_cycles</methodname>
+   <void/>
+  </methodsynopsis>
+  &warn.undocumented.func;
+  <para>
+   Forces collection of any existing garbage cycles.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+ 
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns number of collected cycles.
+  </para>
+ </refsect1>
+
+ <!-- Use when ERRORS exist
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   When does this function throw E_* level errors, or exceptions?
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when a CHANGELOG exists
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <para>
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>&Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>Enter the PHP version of change here</entry>
+       <entry>Description of change</entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when examples exist
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>A <function>gc_collect_cycles</function> example</title>
+    <para>
+     Any text that describes the purpose of the example, or
+     what goes on in the example should go here (inside the
+     <example> tag, not out
+    </para>
+    <programlisting role="php">
+<![CDATA[
+<?php
+if ($anexample === true) {
+    echo 'Use the PEAR Coding Standards';
+}
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+Use the PEAR Coding Standards
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when adding See Also links
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function></function></member>
+    <member>Or <link linkend="somethingelse">something else</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/gc-disable.xml b/reference/info/functions/gc-disable.xml
new file mode 100644
index 0000000000..a9fcc88a8c
--- /dev/null
+++ b/reference/info/functions/gc-disable.xml
@@ -0,0 +1,130 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+<refentry xml:id="function.gc-disable" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>gc_disable</refname>
+  <refpurpose>Deactivates the circular reference collector</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>void</type><methodname>gc_disable</methodname>
+   <void/>
+  </methodsynopsis>
+  &warn.undocumented.func;
+  <para>
+   Deactivates the circular reference collector.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+ 
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.void;
+  </para>
+ </refsect1>
+
+ <!-- Use when ERRORS exist
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   When does this function throw E_* level errors, or exceptions?
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when a CHANGELOG exists
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <para>
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>&Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>Enter the PHP version of change here</entry>
+       <entry>Description of change</entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when examples exist
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>A <function>gc_disable</function> example</title>
+    <para>
+     Any text that describes the purpose of the example, or
+     what goes on in the example should go here (inside the
+     <example> tag, not out
+    </para>
+    <programlisting role="php">
+<![CDATA[
+<?php
+if ($anexample === true) {
+    echo 'Use the PEAR Coding Standards';
+}
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+Use the PEAR Coding Standards
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when adding See Also links
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function></function></member>
+    <member>Or <link linkend="somethingelse">something else</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/gc-enable.xml b/reference/info/functions/gc-enable.xml
new file mode 100644
index 0000000000..a0090658a4
--- /dev/null
+++ b/reference/info/functions/gc-enable.xml
@@ -0,0 +1,130 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+<refentry xml:id="function.gc-enable" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>gc_enable</refname>
+  <refpurpose>Activates the circular reference collector</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>void</type><methodname>gc_enable</methodname>
+   <void/>
+  </methodsynopsis>
+  &warn.undocumented.func;
+  <para>
+   Activates the circular reference collector.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+ 
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.void;
+  </para>
+ </refsect1>
+
+ <!-- Use when ERRORS exist
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   When does this function throw E_* level errors, or exceptions?
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when a CHANGELOG exists
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <para>
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>&Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>Enter the PHP version of change here</entry>
+       <entry>Description of change</entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when examples exist
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>A <function>gc_enable</function> example</title>
+    <para>
+     Any text that describes the purpose of the example, or
+     what goes on in the example should go here (inside the
+     <example> tag, not out
+    </para>
+    <programlisting role="php">
+<![CDATA[
+<?php
+if ($anexample === true) {
+    echo 'Use the PEAR Coding Standards';
+}
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+Use the PEAR Coding Standards
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when adding See Also links
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function></function></member>
+    <member>Or <link linkend="somethingelse">something else</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/gc-enabled.xml b/reference/info/functions/gc-enabled.xml
new file mode 100644
index 0000000000..e0bd49692b
--- /dev/null
+++ b/reference/info/functions/gc-enabled.xml
@@ -0,0 +1,130 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+<refentry xml:id="function.gc-enabled" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>gc_enabled</refname>
+  <refpurpose>Returns status of the circular reference collector</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>gc_enabled</methodname>
+   <void/>
+  </methodsynopsis>
+  &warn.undocumented.func;
+  <para>
+   Returns status of the circular reference collector.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+ 
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns &true; if the garbage collector is enabled, &false; otherwise.
+  </para>
+ </refsect1>
+
+ <!-- Use when ERRORS exist
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   When does this function throw E_* level errors, or exceptions?
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when a CHANGELOG exists
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <para>
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>&Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>Enter the PHP version of change here</entry>
+       <entry>Description of change</entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when examples exist
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>A <function>gc_enabled</function> example</title>
+    <para>
+     Any text that describes the purpose of the example, or
+     what goes on in the example should go here (inside the
+     <example> tag, not out
+    </para>
+    <programlisting role="php">
+<![CDATA[
+<?php
+if ($anexample === true) {
+    echo 'Use the PEAR Coding Standards';
+}
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+Use the PEAR Coding Standards
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+ -->
+
+ <!-- Use when adding See Also links
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function></function></member>
+    <member>Or <link linkend="somethingelse">something else</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/ini.xml b/reference/info/ini.xml
index 77c696b89e..932f17ed4a 100644
--- a/reference/info/ini.xml
+++ b/reference/info/ini.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.25 $ -->
+<!-- $Revision: 1.26 $ -->
 <section xml:id="info.configuration" xmlns="http://docbook.org/ns/docbook">
  &reftitle.runtime;
  &extension.runtime;
@@ -82,6 +82,12 @@
      <entry>PHP_INI_ALL</entry>
      <entry>Removed in PHP 6.0.0.</entry>
     </row>
+    <row>
+     <entry>zend.enable_gc</entry>
+     <entry>"1"</entry>
+     <entry>PHP_INI_ALL</entry>
+     <entry>Available since PHP 5.3.0.</entry>
+    </row>
     </tbody>
    </tgroup>
   </table>
@@ -294,6 +300,18 @@
     </listitem>
    </varlistentry>
 
+   <varlistentry xml:id="ini.zend.enable-gc">
+    <term>
+     <parameter>zend.enable_gc</parameter>
+     <type>boolean</type>
+    </term>
+    <listitem>
+     <para>
+      Enables or disables the circular reference collector.
+     </para>
+    </listitem>
+   </varlistentry>
+
   </variablelist>
  </para>
 </section>