[DOC-CVS] [doc-en] master: apcu: fix XML to get remove of useless wrapping para tags
[email protected] (Gina Peter Banyard)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Gina Peter Banyard (Girgias)
Date: 2026-01-15T21:42:37Z
Commit: https://github.com/php/doc-en/commit/9d0ec238db7e3ec3c2b9339a3b54aade06f23fe4
Raw diff: https://github.com/php/doc-en/commit/9d0ec238db7e3ec3c2b9339a3b54aade06f23fe4.diff
apcu: fix XML to get remove of useless wrapping para tags
Changed paths:
M reference/apcu/apcuiterator/construct.xml
M reference/apcu/constants.xml
M reference/apcu/functions/apcu-add.xml
M reference/apcu/functions/apcu-cache-info.xml
M reference/apcu/functions/apcu-clear-cache.xml
M reference/apcu/functions/apcu-delete.xml
M reference/apcu/functions/apcu-entry.xml
M reference/apcu/functions/apcu-fetch.xml
M reference/apcu/functions/apcu-key-info.xml
M reference/apcu/functions/apcu-sma-info.xml
M reference/apcu/functions/apcu-store.xml
M reference/apcu/ini.xml
Diff:
diff --git a/reference/apcu/apcuiterator/construct.xml b/reference/apcu/apcuiterator/construct.xml
index dcf9a1dbd3a2..e6264ca24967 100644
--- a/reference/apcu/apcuiterator/construct.xml
+++ b/reference/apcu/apcuiterator/construct.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="apcuiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="apcuiterator.construct">
<refnamediv>
<refname>APCUIterator::__construct</refname>
<refpurpose>Constructs an APCUIterator iterator object</refpurpose>
@@ -67,10 +66,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>A <function>APCUIterator::__construct</function> example</title>
- <programlisting role="php">
+ <example>
+ <title>A <function>APCUIterator::__construct</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
foreach (new APCUIterator('/^counter\./') as $counter) {
@@ -79,9 +77,8 @@ foreach (new APCUIterator('/^counter\./') as $counter) {
}
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
@@ -93,7 +90,6 @@ foreach (new APCUIterator('/^counter\./') as $counter) {
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/apcu/constants.xml b/reference/apcu/constants.xml
index d381026d238c..6f53dbd84588 100644
--- a/reference/apcu/constants.xml
+++ b/reference/apcu/constants.xml
@@ -1,226 +1,220 @@
<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision$ -->
-
-<appendix xml:id="apcu.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<!-- $Revision$ --><appendix xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="apcu.constants">
&reftitle.constants;
&extension.constants;
- <para>
- <variablelist>
- <varlistentry xml:id="constant.apc-iter-all">
- <term>
- <constant>APC_ITER_ALL</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.apc-iter-atime">
- <term>
- <constant>APC_ITER_ATIME</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.apc-iter-ctime">
- <term>
- <constant>APC_ITER_CTIME</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.apc-iter-device">
- <term>
- <constant>APC_ITER_DEVICE</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.apc-iter-dtime">
- <term>
- <constant>APC_ITER_DTIME</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.apc-iter-filename">
- <term>
- <constant>APC_ITER_FILENAME</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.apc-iter-inode">
- <term>
- <constant>APC_ITER_INODE</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.apc-iter-key">
- <term>
- <constant>APC_ITER_KEY</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.apc-iter-md5">
- <term>
- <constant>APC_ITER_MD5</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.apc-iter-mem-size">
- <term>
- <constant>APC_ITER_MEM_SIZE</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.apc-iter-mtime">
- <term>
- <constant>APC_ITER_MTIME</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.apc-iter-none">
- <term>
- <constant>APC_ITER_NONE</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.apc-iter-num-hits">
- <term>
- <constant>APC_ITER_NUM_HITS</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.apc-iter-refcount">
- <term>
- <constant>APC_ITER_REFCOUNT</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.apc-iter-ttl">
- <term>
- <constant>APC_ITER_TTL</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.apc-iter-type">
- <term>
- <constant>APC_ITER_TYPE</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.apc-iter-value">
- <term>
- <constant>APC_ITER_VALUE</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.apc-list-active">
- <term>
- <constant>APC_LIST_ACTIVE</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="constant.apc-list-deleted">
- <term>
- <constant>APC_LIST_DELETED</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
-
- </simpara>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
-</appendix>
-
-<!-- Keep this comment at the end of the file
+ <variablelist>
+ <varlistentry xml:id="constant.apc-iter-all">
+ <term>
+ <constant>APC_ITER_ALL</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.apc-iter-atime">
+ <term>
+ <constant>APC_ITER_ATIME</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.apc-iter-ctime">
+ <term>
+ <constant>APC_ITER_CTIME</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.apc-iter-device">
+ <term>
+ <constant>APC_ITER_DEVICE</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.apc-iter-dtime">
+ <term>
+ <constant>APC_ITER_DTIME</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.apc-iter-filename">
+ <term>
+ <constant>APC_ITER_FILENAME</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.apc-iter-inode">
+ <term>
+ <constant>APC_ITER_INODE</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.apc-iter-key">
+ <term>
+ <constant>APC_ITER_KEY</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.apc-iter-md5">
+ <term>
+ <constant>APC_ITER_MD5</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.apc-iter-mem-size">
+ <term>
+ <constant>APC_ITER_MEM_SIZE</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.apc-iter-mtime">
+ <term>
+ <constant>APC_ITER_MTIME</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.apc-iter-none">
+ <term>
+ <constant>APC_ITER_NONE</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.apc-iter-num-hits">
+ <term>
+ <constant>APC_ITER_NUM_HITS</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.apc-iter-refcount">
+ <term>
+ <constant>APC_ITER_REFCOUNT</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.apc-iter-ttl">
+ <term>
+ <constant>APC_ITER_TTL</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.apc-iter-type">
+ <term>
+ <constant>APC_ITER_TYPE</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.apc-iter-value">
+ <term>
+ <constant>APC_ITER_VALUE</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.apc-list-active">
+ <term>
+ <constant>APC_LIST_ACTIVE</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="constant.apc-list-deleted">
+ <term>
+ <constant>APC_LIST_DELETED</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+
+ </simpara>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+</appendix><!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
diff --git a/reference/apcu/functions/apcu-add.xml b/reference/apcu/functions/apcu-add.xml
index 133dec8b1837..06248beb6963 100644
--- a/reference/apcu/functions/apcu-add.xml
+++ b/reference/apcu/functions/apcu-add.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.apcu-add" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.apcu-add">
<refnamediv>
<refname>apcu_add</refname>
<refpurpose>
@@ -34,54 +34,52 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- Store the variable using this name. <parameter>key</parameter>s are
- cache-unique, so attempting to use <function>apcu_add</function> to
- store data with a key that already exists will not overwrite the
- existing data, and will instead return &false;. (This is the only
- difference between <function>apcu_add</function> and
- <function>apcu_store</function>.)
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>var</parameter></term>
- <listitem>
- <para>
- The variable to store
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>ttl</parameter></term>
- <listitem>
- <para>
- Time To Live; store <parameter>var</parameter> in the cache for
- <parameter>ttl</parameter> seconds. After the
- <parameter>ttl</parameter> has passed, the stored variable will be
- expunged from the cache (on the next request). If no <parameter>ttl</parameter>
- is supplied (or if the <parameter>ttl</parameter> is
- <literal>0</literal>), the value will persist until it is removed from
- the cache manually, or otherwise fails to exist in the cache (clear,
- restart, etc.).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>values</parameter></term>
- <listitem>
- <para>
- Names in key, variables in value.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ Store the variable using this name. <parameter>key</parameter>s are
+ cache-unique, so attempting to use <function>apcu_add</function> to
+ store data with a key that already exists will not overwrite the
+ existing data, and will instead return &false;. (This is the only
+ difference between <function>apcu_add</function> and
+ <function>apcu_store</function>.)
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>var</parameter></term>
+ <listitem>
+ <para>
+ The variable to store
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>ttl</parameter></term>
+ <listitem>
+ <para>
+ Time To Live; store <parameter>var</parameter> in the cache for
+ <parameter>ttl</parameter> seconds. After the
+ <parameter>ttl</parameter> has passed, the stored variable will be
+ expunged from the cache (on the next request). If no <parameter>ttl</parameter>
+ is supplied (or if the <parameter>ttl</parameter> is
+ <literal>0</literal>), the value will persist until it is removed from
+ the cache manually, or otherwise fails to exist in the cache (clear,
+ restart, etc.).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>values</parameter></term>
+ <listitem>
+ <para>
+ Names in key, variables in value.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -93,10 +91,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>A <function>apcu_add</function> example</title>
- <programlisting role="php">
+ <example>
+ <title>A <function>apcu_add</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$bar = 'BAR';
@@ -109,16 +106,15 @@ var_dump(apcu_fetch('foo'));
echo "\n";
?>
]]>
- </programlisting>
- &example.outputs;
- <screen>
+ </programlisting>
+ &example.outputs;
+ <screen>
<![CDATA[
string(3) "BAR"
string(3) "BAR"
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
<refsect1 role="seealso">
@@ -133,7 +129,6 @@ string(3) "BAR"
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/apcu/functions/apcu-cache-info.xml b/reference/apcu/functions/apcu-cache-info.xml
index 503f5c00800a..08c112fe2cdf 100644
--- a/reference/apcu/functions/apcu-cache-info.xml
+++ b/reference/apcu/functions/apcu-cache-info.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.apcu-cache-info" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.apcu-cache-info">
<refnamediv>
<refname>apcu_cache_info</refname>
<refpurpose>
@@ -20,20 +20,18 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>limited</parameter></term>
- <listitem>
- <para>
- If <parameter>limited</parameter> is &true;, the
- return value will exclude the individual list of cache entries. This
- is useful when trying to optimize calls for statistics gathering.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>limited</parameter></term>
+ <listitem>
+ <para>
+ If <parameter>limited</parameter> is &true;, the
+ return value will exclude the individual list of cache entries. This
+ is useful when trying to optimize calls for statistics gathering.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -51,33 +49,31 @@
<refsect1 role="changelog">
&reftitle.changelog;
- <para>
- <informaltable>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>&Version;</entry>
- <entry>&Description;</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>PECL apcu 3.0.11</entry>
- <entry>
- The <parameter>limited</parameter> parameter was introduced.
- </entry>
- </row>
- <row>
- <entry>PECL apcu 3.0.16</entry>
- <entry>
- The "<literal>filehits</literal>" option for the
- <parameter>cache_type</parameter> parameter was introduced.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </para>
+ <informaltable>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>&Version;</entry>
+ <entry>&Description;</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>PECL apcu 3.0.11</entry>
+ <entry>
+ The <parameter>limited</parameter> parameter was introduced.
+ </entry>
+ </row>
+ <row>
+ <entry>PECL apcu 3.0.16</entry>
+ <entry>
+ The "<literal>filehits</literal>" option for the
+ <parameter>cache_type</parameter> parameter was introduced.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
</refsect1>
<refsect1 role="examples">
@@ -128,18 +124,15 @@ Array
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><link linkend="apcu.configuration">APCu configuration directives</link></member>
- <member><methodname>APCUIterator::getTotalSize</methodname></member>
- <member><methodname>APCUIterator::getTotalHits</methodname></member>
- <member><methodname>APCUIterator::getTotalCount</methodname></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><link linkend="apcu.configuration">APCu configuration directives</link></member>
+ <member><methodname>APCUIterator::getTotalSize</methodname></member>
+ <member><methodname>APCUIterator::getTotalHits</methodname></member>
+ <member><methodname>APCUIterator::getTotalCount</methodname></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/apcu/functions/apcu-clear-cache.xml b/reference/apcu/functions/apcu-clear-cache.xml
index 9223fb0b8a0b..8c50e166048d 100644
--- a/reference/apcu/functions/apcu-clear-cache.xml
+++ b/reference/apcu/functions/apcu-clear-cache.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.apcu-clear-cache" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.apcu-clear-cache">
<refnamediv>
<refname>apcu_clear_cache</refname>
<refpurpose>
@@ -32,15 +32,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>apcu_cache_info</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>apcu_cache_info</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/apcu/functions/apcu-delete.xml b/reference/apcu/functions/apcu-delete.xml
index 648053a2e295..e1a59633b51f 100644
--- a/reference/apcu/functions/apcu-delete.xml
+++ b/reference/apcu/functions/apcu-delete.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.apcu-delete" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.apcu-delete">
<refnamediv>
<refname>apcu_delete</refname>
<refpurpose>
@@ -19,21 +19,19 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- A <parameter>key</parameter> used to store the value as a
- <type>string</type> for a single key,
- or as an <type>array</type> of strings for several keys,
- or as an <classname>APCUIterator</classname> <type>object</type>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ A <parameter>key</parameter> used to store the value as a
+ <type>string</type> for a single key,
+ or as an <type>array</type> of strings for several keys,
+ or as an <classname>APCUIterator</classname> <type>object</type>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -45,10 +43,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>A <function>apcu_delete</function> example</title>
- <programlisting role="php">
+ <example>
+ <title>A <function>apcu_delete</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$bar = 'BAR';
@@ -63,9 +60,8 @@ apcu_delete(['foo', 'bar', 'baz']);
apcu_delete(new APCUIterator('#^myprefix_#'));
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
@@ -81,7 +77,6 @@ apcu_delete(new APCUIterator('#^myprefix_#'));
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/apcu/functions/apcu-entry.xml b/reference/apcu/functions/apcu-entry.xml
index 4caa3dea9543..71b0aa4cfec4 100644
--- a/reference/apcu/functions/apcu-entry.xml
+++ b/reference/apcu/functions/apcu-entry.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.apcu-entry" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.apcu-entry">
<refnamediv>
<refname>apcu_entry</refname>
<refpurpose>
@@ -22,7 +22,7 @@
</para>
<note>
<simpara>
- When control enters <function>apcu_entry</function> the lock for the cache is acquired exclusively, it is released when control leaves <function>apcu_entry</function>:
+ When control enters <function>apcu_entry</function> the lock for the cache is acquired exclusively, it is released when control leaves <function>apcu_entry</function>:
In effect, this turns the body of <parameter>callback</parameter> into a critical section, disallowing two processes from executing the same code paths concurrently.
In addition, it prohibits the concurrent execution of any other APCu functions, since they will acquire the same lock.
</simpara>
@@ -35,41 +35,39 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- Identity of cache entry
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>callback</parameter></term>
- <listitem>
- <para>
- A callable that accepts <parameter>key</parameter> as the only argument and returns the value to cache.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>ttl</parameter></term>
- <listitem>
- <para>
- Time To Live; store the <parameter>callback</parameter>'s return value in the cache for
- <parameter>ttl</parameter> seconds. After the
- <parameter>ttl</parameter> has passed, the stored entry will be
- expunged from the cache (on the next request). If no <parameter>ttl</parameter>
- is supplied (or if the <parameter>ttl</parameter> is
- <literal>0</literal>), the value will persist until it is removed from
- the cache manually, or otherwise fails to exist in the cache (clear,
- restart, etc.).
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ Identity of cache entry
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>callback</parameter></term>
+ <listitem>
+ <para>
+ A callable that accepts <parameter>key</parameter> as the only argument and returns the value to cache.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>ttl</parameter></term>
+ <listitem>
+ <para>
+ Time To Live; store the <parameter>callback</parameter>'s return value in the cache for
+ <parameter>ttl</parameter> seconds. After the
+ <parameter>ttl</parameter> has passed, the stored entry will be
+ expunged from the cache (on the next request). If no <parameter>ttl</parameter>
+ is supplied (or if the <parameter>ttl</parameter> is
+ <literal>0</literal>), the value will persist until it is removed from
+ the cache manually, or otherwise fails to exist in the cache (clear,
+ restart, etc.).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -80,10 +78,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>An <function>apcu_entry</function> example</title>
- <programlisting role="php">
+ <example>
+ <title>An <function>apcu_entry</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$config = apcu_entry("config", function($key) {
@@ -93,7 +90,7 @@ $config = apcu_entry("config", function($key) {
"apples",
"pears"
];
- }),
+ }),
"people" => apcu_entry("config.people", function($key){
return [
"bob",
@@ -107,9 +104,9 @@ $config = apcu_entry("config", function($key) {
var_dump($config);
?>
]]>
- </programlisting>
- &example.outputs;
- <screen>
+ </programlisting>
+ &example.outputs;
+ <screen>
<![CDATA[
array(2) {
["fruit"]=>
@@ -130,9 +127,8 @@ array(2) {
}
}
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
<refsect1 role="seealso">
@@ -147,7 +143,6 @@ array(2) {
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/apcu/functions/apcu-fetch.xml b/reference/apcu/functions/apcu-fetch.xml
index a35e061357bb..4ee448e80159 100644
--- a/reference/apcu/functions/apcu-fetch.xml
+++ b/reference/apcu/functions/apcu-fetch.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.apcu-fetch" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.apcu-fetch">
<refnamediv>
<refname>apcu_fetch</refname>
<refpurpose>
@@ -20,28 +20,26 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- The <parameter>key</parameter> used to store the value (with
- <function>apcu_store</function>). If an array is passed then each
- element is fetched and returned.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>success</parameter></term>
- <listitem>
- <para>
- Set to &true; in success and &false; in failure.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ The <parameter>key</parameter> used to store the value (with
+ <function>apcu_store</function>). If an array is passed then each
+ element is fetched and returned.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>success</parameter></term>
+ <listitem>
+ <para>
+ Set to &true; in success and &false; in failure.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -74,10 +72,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>A <function>apcu_fetch</function> example</title>
- <programlisting role="php">
+ <example>
+ <title>A <function>apcu_fetch</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$bar = 'BAR';
@@ -85,15 +82,14 @@ apcu_store('foo', $bar);
var_dump(apcu_fetch('foo'));
?>
]]>
- </programlisting>
- &example.outputs;
- <screen>
+ </programlisting>
+ &example.outputs;
+ <screen>
<![CDATA[
string(3) "BAR"
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
<refsect1 role="seealso">
@@ -108,7 +104,6 @@ string(3) "BAR"
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/apcu/functions/apcu-key-info.xml b/reference/apcu/functions/apcu-key-info.xml
index 955e7e9b32e8..b592bcf8d9fb 100644
--- a/reference/apcu/functions/apcu-key-info.xml
+++ b/reference/apcu/functions/apcu-key-info.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.apcu-key-info" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.apcu-key-info">
<refnamediv>
<refname>apcu_key_info</refname>
<refpurpose>
@@ -21,18 +21,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- Get detailed information about the cache key
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ Get detailed information about the cache key
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -44,19 +42,18 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>A <function>apcu_key_info</function> example</title>
- <programlisting role="php">
+ <example>
+ <title>A <function>apcu_key_info</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
apcu_add('a','b');
var_dump(apcu_key_info('a'));
?>
]]>
- </programlisting>
- &example.outputs;
- <screen>
+ </programlisting>
+ &example.outputs;
+ <screen>
<![CDATA[
array(7) {
["hits"]=>
@@ -75,9 +72,8 @@ array(7) {
int(0)
}
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
<refsect1 role="seealso">
@@ -92,7 +88,6 @@ array(7) {
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -112,4 +107,4 @@ End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
--->
\ No newline at end of file
+-->
diff --git a/reference/apcu/functions/apcu-sma-info.xml b/reference/apcu/functions/apcu-sma-info.xml
index 68ddb10dbb17..a8906395672b 100644
--- a/reference/apcu/functions/apcu-sma-info.xml
+++ b/reference/apcu/functions/apcu-sma-info.xml
@@ -20,19 +20,17 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>limited</parameter></term>
- <listitem>
- <para>
- When set to &false; (default) <function>apcu_sma_info</function> will
- return a detailed information about each segment.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>limited</parameter></term>
+ <listitem>
+ <para>
+ When set to &false; (default) <function>apcu_sma_info</function> will
+ return a detailed information about each segment.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -44,18 +42,17 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>A <function>apcu_sma_info</function> example</title>
- <programlisting role="php">
+ <example>
+ <title>A <function>apcu_sma_info</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
print_r(apcu_sma_info());
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
Array
(
@@ -78,9 +75,8 @@ Array
)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
<refsect1 role="seealso">
@@ -95,7 +91,6 @@ Array
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/apcu/functions/apcu-store.xml b/reference/apcu/functions/apcu-store.xml
index ea3d955572fe..2351485bf4bc 100644
--- a/reference/apcu/functions/apcu-store.xml
+++ b/reference/apcu/functions/apcu-store.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.apcu-store" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.apcu-store">
<refnamediv>
<refname>apcu_store</refname>
<refpurpose>
@@ -34,51 +34,49 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- Store the variable using this name. <parameter>key</parameter>s are
- cache-unique, so storing a second value with the same
- <parameter>key</parameter> will overwrite the original value.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>var</parameter></term>
- <listitem>
- <para>
- The variable to store
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>ttl</parameter></term>
- <listitem>
- <para>
- Time To Live; store <parameter>var</parameter> in the cache for
- <parameter>ttl</parameter> seconds. After the
- <parameter>ttl</parameter> has passed, the stored variable will be
- expunged from the cache (on the next request). If no <parameter>ttl</parameter>
- is supplied (or if the <parameter>ttl</parameter> is
- <literal>0</literal>), the value will persist until it is removed from
- the cache manually, or otherwise fails to exist in the cache (clear,
- restart, etc.).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>values</parameter></term>
- <listitem>
- <para>
- Names in key, variables in value.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ Store the variable using this name. <parameter>key</parameter>s are
+ cache-unique, so storing a second value with the same
+ <parameter>key</parameter> will overwrite the original value.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>var</parameter></term>
+ <listitem>
+ <para>
+ The variable to store
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>ttl</parameter></term>
+ <listitem>
+ <para>
+ Time To Live; store <parameter>var</parameter> in the cache for
+ <parameter>ttl</parameter> seconds. After the
+ <parameter>ttl</parameter> has passed, the stored variable will be
+ expunged from the cache (on the next request). If no <parameter>ttl</parameter>
+ is supplied (or if the <parameter>ttl</parameter> is
+ <literal>0</literal>), the value will persist until it is removed from
+ the cache manually, or otherwise fails to exist in the cache (clear,
+ restart, etc.).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>values</parameter></term>
+ <listitem>
+ <para>
+ Names in key, variables in value.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -90,10 +88,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>A <function>apcu_store</function> example</title>
- <programlisting role="php">
+ <example>
+ <title>A <function>apcu_store</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$bar = 'BAR';
@@ -101,15 +98,14 @@ apcu_store('foo', $bar);
var_dump(apcu_fetch('foo'));
?>
]]>
- </programlisting>
- &example.outputs;
- <screen>
+ </programlisting>
+ &example.outputs;
+ <screen>
<![CDATA[
string(3) "BAR"
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
<refsect1 role="seealso">
@@ -124,7 +120,6 @@ string(3) "BAR"
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/apcu/ini.xml b/reference/apcu/ini.xml
index 471d6b527b64..18eb6a5926ed 100644
--- a/reference/apcu/ini.xml
+++ b/reference/apcu/ini.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<section xml:id="apcu.configuration" xmlns="http://docbook.org/ns/docbook">
+<section xmlns="http://docbook.org/ns/docbook" xml:id="apcu.configuration">
&reftitle.runtime;
&extension.runtime;
<para>
@@ -8,7 +8,7 @@
users should consider tuning the following parameters.
</para>
<para>
- There is one decision to be made configuring APCu.
+ There is one decision to be made configuring APCu.
How much memory is going to be allocated to APCu.
The ini directive that controls this is <literal>apc.shm_size</literal>
Read the sections on this carefully below.
@@ -16,7 +16,7 @@
<para>
Once the server is running, the <literal>apc.php</literal> script that
is bundled with the extension should be copied somewhere into the docroot and
- viewed with a browser as it provides a detailed analysis of the internal
+ viewed with a browser as it provides a detailed analysis of the internal
workings of APCu. If GD is enabled in PHP, it will even display some
interesting graphs.</para>
<para>
@@ -37,11 +37,11 @@
to minimize this number is to allocate more memory for APCu.
</para>
<para>
- When APCu is compiled with mmap support (Memory Mapping), it will use only one
- memory segment, unlike when APCu is built with SHM (SysV Shared Memory) support
- that uses multiple memory segments. MMAP does not have a maximum limit like SHM
- does in <literal>/proc/sys/kernel/shmmax</literal>. In general MMAP support is
- recommended because it will reclaim the memory faster when the webserver is
+ When APCu is compiled with mmap support (Memory Mapping), it will use only one
+ memory segment, unlike when APCu is built with SHM (SysV Shared Memory) support
+ that uses multiple memory segments. MMAP does not have a maximum limit like SHM
+ does in <literal>/proc/sys/kernel/shmmax</literal>. In general MMAP support is
+ recommended because it will reclaim the memory faster when the webserver is
restarted and all in all reduces memory allocation impact at startup.
</para>
<para>
@@ -61,19 +61,19 @@
<entry><link linkend="ini.apcu.enabled">apc.enabled</link></entry>
<entry>1</entry>
<entry><constant>INI_SYSTEM</constant></entry>
- <entry></entry>
+ <entry/>
</row>
<row>
<entry><link linkend="ini.apcu.shm-segments">apc.shm_segments</link></entry>
<entry>1</entry>
<entry><constant>INI_SYSTEM</constant></entry>
- <entry></entry>
+ <entry/>
</row>
<row>
<entry><link linkend="ini.apcu.shm-size">apc.shm_size</link></entry>
<entry>"32M"</entry>
<entry><constant>INI_SYSTEM</constant></entry>
- <entry></entry>
+ <entry/>
</row>
<row>
<entry><link linkend="ini.apcu.entries-hint">apc.entries_hint</link></entry>
@@ -85,31 +85,31 @@
<entry><link linkend="ini.apcu.ttl">apc.ttl</link></entry>
<entry>0</entry>
<entry><constant>INI_SYSTEM</constant></entry>
- <entry></entry>
+ <entry/>
</row>
<row>
<entry><link linkend="ini.apcu.gc-ttl">apc.gc_ttl</link></entry>
<entry>3600</entry>
<entry><constant>INI_SYSTEM</constant></entry>
- <entry></entry>
+ <entry/>
</row>
<row>
<entry><link linkend="ini.apcu.mmap-file-mask">apc.mmap_file_mask</link></entry>
<entry>NULL</entry>
<entry><constant>INI_SYSTEM</constant></entry>
- <entry></entry>
+ <entry/>
</row>
<row>
<entry><link linkend="ini.apcu.slam-defense">apc.slam_defense</link></entry>
<entry>0</entry>
<entry><constant>INI_SYSTEM</constant></entry>
- <entry></entry>
+ <entry/>
</row>
<row>
<entry><link linkend="ini.apcu.enable-cli">apc.enable_cli</link></entry>
<entry>0</entry>
<entry><constant>INI_SYSTEM</constant></entry>
- <entry></entry>
+ <entry/>
</row>
<row>
<entry><link linkend="ini.apcu.use-request-time">apc.use_request_time</link></entry>
@@ -127,244 +127,241 @@
<entry><link linkend="ini.apcu.coredump-unmap">apc.coredump_unmap</link></entry>
<entry>0</entry>
<entry><constant>INI_SYSTEM</constant></entry>
- <entry></entry>
+ <entry/>
</row>
<row>
<entry><link linkend="ini.apcu.preload-path">apc.preload_path</link></entry>
<entry>NULL</entry>
<entry><constant>INI_SYSTEM</constant></entry>
- <entry></entry>
+ <entry/>
</row>
</tbody>
</tgroup>
</table>
&ini.php.constants;
</para>
-
+
&ini.descriptions.title;
-
- <para>
- <variablelist>
- <varlistentry xml:id="ini.apcu.enabled">
- <term>
- <parameter>apc.enabled</parameter>
- <type>bool</type>
- </term>
- <listitem>
- <para>
- <literal>apc.enabled</literal> can be set to 0 to disable APC. This is
- primarily useful when APC is statically compiled
- into PHP, since there is no other way to disable
- it (when compiled as a DSO, the <literal>extension</literal>
- line in <literal>php.ini</literal> can just be commented-out).
- </para>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="ini.apcu.shm-segments">
- <term>
- <parameter>apc.shm_segments</parameter>
- <type>int</type>
- </term>
- <listitem>
- <para>
- The number of shared memory segments to allocate
- for the compiler cache. If APC is running out of
- shared memory but <literal>apc.shm_size</literal>
- is set as high as the system allows, raising
- this value might prevent APC from exhausting its memory.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="ini.apcu.shm-size">
- <term>
- <parameter>apc.shm_size</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- The size of each shared memory segment given by a shorthand notation as
- described in <link linkend="faq.using.shorthandbytes">this FAQ</link>.
- By default, some systems (including most BSD
- variants) have very low limits on the size of a
- shared memory segment.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="ini.apcu.entries-hint">
- <term>
- <parameter>apc.entries_hint</parameter>
- <type>int</type>
- </term>
- <listitem>
- <para>
- A "hint" about the number of distinct variables that might be stored.
- Set to zero or omit if not sure.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="ini.apcu.ttl">
- <term>
- <parameter>apc.ttl</parameter>
- <type>int</type>
- </term>
- <listitem>
- <para>
- Consider cache entries without an explicit TTL to be
- expired if they have not been accessed in this many
- seconds. Effectively, this allows such entries to be
- removed opportunistically during a cache insert, or
- prior to a full expunge. Note that because removal is
- opportunistic, entries can still be readable even if
- they are older than <literal>apc.ttl</literal> seconds.
- This setting has no effect on cache entries that have
- an explicit TTL specified.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="ini.apcu.gc-ttl">
- <term>
- <parameter>apc.gc_ttl</parameter>
- <type>int</type>
- </term>
- <listitem>
- <para>
- The number of seconds that a cache entry may
- remain on the garbage-collection list after being removed or invalidated.
- Entries are eligible for removal if their reference count is zero,
- or they exceed this time limit.
- If set to <literal>0</literal>, time-based cleanup is disabled,
- and entries are only removed when their reference count drops to zero.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="ini.apcu.mmap-file-mask">
- <term>
- <parameter>apc.mmap_file_mask</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- If compiled with MMAP support by using <literal>--enable-mmap</literal>
- this is the mktemp-style file_mask to pass to the
- mmap module for determining whether your mmap'ed memory
- region is going to be file-backed or shared memory
- backed. For straight file-backed mmap, set it to
- something like <literal>/tmp/apc.XXXXXX</literal>
- (exactly 6 <literal>X</literal>s).
- To use POSIX-style shm_open/mmap put a <literal>.shm</literal>
- somewhere in your mask. e.g. <literal>/apc.shm.XXXXXX</literal>
- You can also set it to <literal>/dev/zero</literal> to use your
- kernel's <literal>/dev/zero</literal> interface to anonymous mmap'ed
- memory. Leaving it undefined will force an anonymous mmap.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="ini.apcu.slam-defense">
- <term>
- <parameter>apc.slam_defense</parameter>
- <type>bool</type>
- </term>
- <listitem>
- <para>
- On very busy servers whenever you start the server or
- modify files you can create a race of many processes
- all trying to cache the same file at the same time.
- Setting <literal>apc.slam_defense</literal> to <literal>1</literal>
- can help prevent multiple processes from caching the
- same file simultaneously by introducing a probability
- mechanism. If the same key is attempted to be cached
- within a short period by different processes, it skips
- the caching for the current process to mitigate potential
- cache slams.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="ini.apcu.enable-cli">
- <term>
- <parameter>apc.enable_cli</parameter>
- <type>int</type>
- </term>
- <listitem>
- <para>
- Mostly for testing and debugging. Setting this enables APC
- for the CLI version of PHP. Under normal circumstances, it is
- not ideal to create, populate and destroy the APC cache on every
- CLI request, but for various test scenarios it is useful to be
- able to enable APC for the CLI version of PHP easily.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="ini.apcu.serializer">
- <term>
- <parameter>apc.serializer</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- Used to configure APC to use a third party serializer.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="ini.apcu.coredump-unmap">
- <term>
- <parameter>apc.coredump_unmap</parameter>
- <type>bool</type>
- </term>
- <listitem>
+
+ <variablelist>
+ <varlistentry xml:id="ini.apcu.enabled">
+ <term>
+ <parameter>apc.enabled</parameter>
+ <type>bool</type>
+ </term>
+ <listitem>
+ <para>
+ <literal>apc.enabled</literal> can be set to 0 to disable APC. This is
+ primarily useful when APC is statically compiled
+ into PHP, since there is no other way to disable
+ it (when compiled as a DSO, the <literal>extension</literal>
+ line in <literal>php.ini</literal> can just be commented-out).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="ini.apcu.shm-segments">
+ <term>
+ <parameter>apc.shm_segments</parameter>
+ <type>int</type>
+ </term>
+ <listitem>
+ <para>
+ The number of shared memory segments to allocate
+ for the compiler cache. If APC is running out of
+ shared memory but <literal>apc.shm_size</literal>
+ is set as high as the system allows, raising
+ this value might prevent APC from exhausting its memory.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="ini.apcu.shm-size">
+ <term>
+ <parameter>apc.shm_size</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ The size of each shared memory segment given by a shorthand notation as
+ described in <link linkend="faq.using.shorthandbytes">this FAQ</link>.
+ By default, some systems (including most BSD
+ variants) have very low limits on the size of a
+ shared memory segment.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="ini.apcu.entries-hint">
+ <term>
+ <parameter>apc.entries_hint</parameter>
+ <type>int</type>
+ </term>
+ <listitem>
+ <para>
+ A "hint" about the number of distinct variables that might be stored.
+ Set to zero or omit if not sure.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="ini.apcu.ttl">
+ <term>
+ <parameter>apc.ttl</parameter>
+ <type>int</type>
+ </term>
+ <listitem>
+ <para>
+ Consider cache entries without an explicit TTL to be
+ expired if they have not been accessed in this many
+ seconds. Effectively, this allows such entries to be
+ removed opportunistically during a cache insert, or
+ prior to a full expunge. Note that because removal is
+ opportunistic, entries can still be readable even if
+ they are older than <literal>apc.ttl</literal> seconds.
+ This setting has no effect on cache entries that have
+ an explicit TTL specified.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="ini.apcu.gc-ttl">
+ <term>
+ <parameter>apc.gc_ttl</parameter>
+ <type>int</type>
+ </term>
+ <listitem>
+ <para>
+ The number of seconds that a cache entry may
+ remain on the garbage-collection list after being removed or invalidated.
+ Entries are eligible for removal if their reference count is zero,
+ or they exceed this time limit.
+ If set to <literal>0</literal>, time-based cleanup is disabled,
+ and entries are only removed when their reference count drops to zero.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="ini.apcu.mmap-file-mask">
+ <term>
+ <parameter>apc.mmap_file_mask</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ If compiled with MMAP support by using <literal>--enable-mmap</literal>
+ this is the mktemp-style file_mask to pass to the
+ mmap module for determining whether your mmap'ed memory
+ region is going to be file-backed or shared memory
+ backed. For straight file-backed mmap, set it to
+ something like <literal>/tmp/apc.XXXXXX</literal>
+ (exactly 6 <literal>X</literal>s).
+ To use POSIX-style shm_open/mmap put a <literal>.shm</literal>
+ somewhere in your mask. e.g. <literal>/apc.shm.XXXXXX</literal>
+ You can also set it to <literal>/dev/zero</literal> to use your
+ kernel's <literal>/dev/zero</literal> interface to anonymous mmap'ed
+ memory. Leaving it undefined will force an anonymous mmap.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="ini.apcu.slam-defense">
+ <term>
+ <parameter>apc.slam_defense</parameter>
+ <type>bool</type>
+ </term>
+ <listitem>
+ <para>
+ On very busy servers whenever you start the server or
+ modify files you can create a race of many processes
+ all trying to cache the same file at the same time.
+ Setting <literal>apc.slam_defense</literal> to <literal>1</literal>
+ can help prevent multiple processes from caching the
+ same file simultaneously by introducing a probability
+ mechanism. If the same key is attempted to be cached
+ within a short period by different processes, it skips
+ the caching for the current process to mitigate potential
+ cache slams.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="ini.apcu.enable-cli">
+ <term>
+ <parameter>apc.enable_cli</parameter>
+ <type>int</type>
+ </term>
+ <listitem>
+ <para>
+ Mostly for testing and debugging. Setting this enables APC
+ for the CLI version of PHP. Under normal circumstances, it is
+ not ideal to create, populate and destroy the APC cache on every
+ CLI request, but for various test scenarios it is useful to be
+ able to enable APC for the CLI version of PHP easily.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="ini.apcu.serializer">
+ <term>
+ <parameter>apc.serializer</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ Used to configure APC to use a third party serializer.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="ini.apcu.coredump-unmap">
+ <term>
+ <parameter>apc.coredump_unmap</parameter>
+ <type>bool</type>
+ </term>
+ <listitem>
+ <para>
+ Enables APC handling of signals, such as SIGSEGV, that write
+ core files when signaled. When these signals are received,
+ APC will attempt to unmap the shared memory segment in order
+ to exclude it from the core file. This setting may improve
+ system stability when fatal signals are received and a large
+ APC shared memory segment is configured.
+ </para>
+ <warning>
<para>
- Enables APC handling of signals, such as SIGSEGV, that write
- core files when signaled. When these signals are received,
- APC will attempt to unmap the shared memory segment in order
- to exclude it from the core file. This setting may improve
- system stability when fatal signals are received and a large
- APC shared memory segment is configured.
+ This feature is potentially dangerous. Unmapping the shared
+ memory segment in a fatal signal handler may cause undefined
+ behaviour if a fatal error occurs.
</para>
- <warning>
- <para>
- This feature is potentially dangerous. Unmapping the shared
- memory segment in a fatal signal handler may cause undefined
- behaviour if a fatal error occurs.
- </para>
- </warning>
- <note>
- <para>
- Although some kernels may provide a facility to ignore various
- types of shared memory when generating a core dump file, these
- implementations may also ignore important shared memory segments
- such as the Apache scoreboard.
- </para>
- </note>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="ini.apcu.preload-path">
- <term>
- <parameter>apc.preload_path</parameter>
- <type>string</type>
- </term>
- <listitem>
+ </warning>
+ <note>
<para>
- Optionally, set a path to the directory that APC will load
- cache data at startup.
+ Although some kernels may provide a facility to ignore various
+ types of shared memory when generating a core dump file, these
+ implementations may also ignore important shared memory segments
+ such as the Apache scoreboard.
</para>
- </listitem>
- </varlistentry>
+ </note>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="ini.apcu.preload-path">
+ <term>
+ <parameter>apc.preload_path</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ Optionally, set a path to the directory that APC will load
+ cache data at startup.
+ </para>
+ </listitem>
+ </varlistentry>
- <varlistentry xml:id="ini.apcu.use-request-time">
- <term>
- <parameter>apc.use_request_time</parameter>
- <type>bool</type>
- </term>
- <listitem>
- <para>
- Use the <acronym>SAPI</acronym> request start time for
- <acronym>TTL</acronym>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <varlistentry xml:id="ini.apcu.use-request-time">
+ <term>
+ <parameter>apc.use_request_time</parameter>
+ <type>bool</type>
+ </term>
+ <listitem>
+ <para>
+ Use the <acronym>SAPI</acronym> request start time for
+ <acronym>TTL</acronym>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml