svn: /phpdoc/en/trunk/reference/apcu/ book.xml functions/apcu-entry.xml ini.xml setup.xml
| From: | Joe Watkins | Date: | Thu, 19 Nov 2015 07:59:46 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/apcu/ book.xml functions/apcu-entry.xml ini.xml setup.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-13856@lists.php.net to get a copy of this message | ||
krakjoe Thu, 19 Nov 2015 07:59:46 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=338150
Log:
revision of documentation, generally improve content
Changed paths:
U phpdoc/en/trunk/reference/apcu/book.xml
U phpdoc/en/trunk/reference/apcu/functions/apcu-entry.xml
U phpdoc/en/trunk/reference/apcu/ini.xml
U phpdoc/en/trunk/reference/apcu/setup.xml
Modified: phpdoc/en/trunk/reference/apcu/book.xml
===================================================================
--- phpdoc/en/trunk/reference/apcu/book.xml 2015-11-18 17:12:55 UTC (rev 338149)
+++ phpdoc/en/trunk/reference/apcu/book.xml 2015-11-19 07:59:46 UTC (rev 338150)
@@ -12,13 +12,13 @@
</para>
<para>
The first APCu codebase was versioned 4.0.0, it was forked from the head of the APC master
branch at the time.
- It came with a compatibility build mode, which served to provide a drop in replacement for
APC's user cache functions and functionality.
</para>
<para>
PHP 7 support is available as of APCu 5.0.0.
- Version 5 still comes with a backward compatibility module, but it's separate from the APCu
module.
- APCu must be configured with --enable-apcu-bc to build the separate (apc.so) module, and it must
be loaded by configuration (after apcu.so).
</para>
+ <para>
+ APCu can provide a compatibility mode, such that it can provide a drop in replacement for the
applicable parts of APC.
+ </para>
</preface>
&reference.apcu.setup;
Modified: phpdoc/en/trunk/reference/apcu/functions/apcu-entry.xml
===================================================================
--- phpdoc/en/trunk/reference/apcu/functions/apcu-entry.xml 2015-11-18 17:12:55 UTC (rev 338149)
+++ phpdoc/en/trunk/reference/apcu/functions/apcu-entry.xml 2015-11-19 07:59:46 UTC (rev 338150)
@@ -18,8 +18,19 @@
<para>
Atomically attempts to find <parameter>key</parameter> in the cache, if it cannot be
found <parameter>generator</parameter>
is called, passing <parameter>key</parameter> as the only argument. The return value
of the call is then cached with the optionally specified
- <parameter>ttl</parameter>
+ <parameter>ttl</parameter>, and returned.
</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>:
+ In effect, this turns the body of <parameter>generator</parameter> into a critical
section, disallowing two processes from executing the same code paths concurrently.
+ </simpara>
+ </note>
+ <warning>
+ <simpara>
+ The only APCu function that can be called safely by
<parameter>generator</parameter> is <function>apcu_entry</function>.
+ </simpara>
+ </warning>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
Modified: phpdoc/en/trunk/reference/apcu/ini.xml
===================================================================
--- phpdoc/en/trunk/reference/apcu/ini.xml 2015-11-18 17:12:55 UTC (rev 338149)
+++ phpdoc/en/trunk/reference/apcu/ini.xml 2015-11-19 07:59:46 UTC (rev 338150)
@@ -67,7 +67,7 @@
<entry></entry>
</row>
<row>
- <entry><link
linkend="ini.apcu.user-entries-hint">apc.user_entries_hint</link></entry>
+ <entry><link
linkend="ini.apcu.entries-hint">apc.entries_hint</link></entry>
<entry>"4096"</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry></entry>
@@ -210,9 +210,9 @@
</para>
</listitem>
</varlistentry>
- <varlistentry xml:id="ini.apcu.user-entries-hint">
+ <varlistentry xml:id="ini.apcu.entries-hint">
<term>
- <parameter>apc.user_entries_hint</parameter>
+ <parameter>apc.entries_hint</parameter>
<type>integer</type>
</term>
<listitem>
Modified: phpdoc/en/trunk/reference/apcu/setup.xml
===================================================================
--- phpdoc/en/trunk/reference/apcu/setup.xml 2015-11-18 17:12:55 UTC (rev 338149)
+++ phpdoc/en/trunk/reference/apcu/setup.xml 2015-11-19 07:59:46 UTC (rev 338150)
@@ -11,19 +11,27 @@
<section xml:id="apcu.installation">
&reftitle.install;
- <para>
- &pecl.moved;
- </para>
- <para>
- &pecl.info;
- <link
xlink:href="&url.pecl.package;apcu">&url.pecl.package;apcu</link>.
- </para>
- <para>
- &pecl.windows.download;
- </para>
+ <para>
+ If backward compatibility with the applicable parts of APC is required,
+ APCu must be configured with the option --enable-apcu-bc.
+ </para>
+ <para>
+ In backward compatibility mode, APCu registers the applicable APC functions
+ with backward compatible prototypes.
+ </para>
+ <para>
+ Where an APC function accepted <parameter>cache_type</parameter>, it is simply
+ ignored by the backward compatible version, and omitted from the prototype for
+ the APCu version.
+ </para>
+ <warning>
+ <simpara>
+ PHP 7 has a separate module (apc.so) for backwards compatibility.
+ </simpara>
+ </warning>
<note>
<simpara>
- On Windows, APC needs a temp path to exist, and be
+ On Windows, APCu needs a temp path to exist, and be
writable by the web server. It checks the TMP, TEMP
and USERPROFILE environment variables in that order
and finally tries the WINDOWS directory if none of
@@ -38,6 +46,9 @@
</link>.
</simpara>
</note>
+ <para>
+ APCu sources can be found <link
xlink:href="&url.git.hub;krakjoe/apcu">here</link>.
+ </para>
</section>
&reference.apcu.ini;