cvs: phpdoc /en/internals2/apiref index.xml /en/internals2/buildsys configunix.xml configwin.xml environment.xml index.xml skeleton.xml
/en/internals2/ze1/streams constants.xml index.xml /en/internals2/ze1/tsrm index.xml /en/internals2/ze1/zendapi index.xml intro.xml

gwynne Thu Jun 28 04:45:10 2007 UTC Modified files: /phpdoc/en/internals2/apiref index.xml /phpdoc/en/internals2/buildsys configunix.xml configwin.xml environment.xml index.xml skeleton.xml /phpdoc/en/internals2/ze1/streams constants.xml index.xml /phpdoc/en/internals2/ze1/tsrm index.xml /phpdoc/en/internals2/ze1/zendapi index.xml intro.xml Log: Several changes to allow internals to build successfully until a proper reorganization of the reference material can be handled.

http://cvs.php.net/viewvc.cgi/phpdoc/en/internals2/apiref/index.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/internals2/apiref/index.xml diff -u phpdoc/en/internals2/apiref/index.xml:1.2 phpdoc/en/internals2/apiref/index.xml:1.3 --- phpdoc/en/internals2/apiref/index.xml:1.2 Wed Jun 20 22:39:08 2007 +++ phpdoc/en/internals2/apiref/index.xml Thu Jun 28 04:45:10 2007 @@ -1,9 +1,8 @@ <?xml version="1.0" encoding="ISO-8859-1" ?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <chapter xml:id="internals2.apiref" xmlns="http://docbook.org/ns/docbook"> <title>Zend Engine 2 API reference</title> - <para> - </para> + <para/> </chapter> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/internals2/buildsys/configunix.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/internals2/buildsys/configunix.xml diff -u phpdoc/en/internals2/buildsys/configunix.xml:1.2 phpdoc/en/internals2/buildsys/configunix.xml:1.3 --- phpdoc/en/internals2/buildsys/configunix.xml:1.2 Wed Jun 20 22:39:08 2007 +++ phpdoc/en/internals2/buildsys/configunix.xml Thu Jun 28 04:45:10 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="ISO-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <sect1 xml:id="internals2.buildsys.configunix" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <title>Talking to the UNIX build system: config.m4</title> <para> @@ -8,8 +8,7 @@ supports, what external libraries and includes you require, and what source files are to be compiled as part of it. A reference to all the commonly used autoconf macros, both PHP-specific and those built into autoconf, is given - in the <link linkend="internals2.apiref">Zend API reference</link> - section. + in the <xref linkend="internals2.apiref"/> section. </para> <tip> @@ -28,7 +27,7 @@ <title>An example config.m4 file</title> <programlisting role="autoconf"> <![CDATA[ -dnl $Id: configunix.xml,v 1.2 2007/06/20 22:39:08 bjori Exp $ +dnl $Id: configunix.xml,v 1.3 2007/06/28 04:45:10 gwynne Exp $ dnl config.m4 for extension example PHP_ARG_WITH(example, for example support, @@ -319,9 +318,9 @@ force the entire extension to be built using <literal>$CXX</literal> instead of <literal>$CC</literal>. All parameters after the third are optional. Finally, <function>PHP_SUBST</function> is called to enable - shared builds of the extension. See - <link linkend="internals2.faq">Extensions FAQs</link> for more information - on disabling support for building an extension in shared mode. + shared builds of the extension. See <xref linkend="internals2.faq"/> for + more information on disabling support for building an extension in shared + mode. </para> </sect2> </sect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/internals2/buildsys/configwin.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/internals2/buildsys/configwin.xml diff -u phpdoc/en/internals2/buildsys/configwin.xml:1.2 phpdoc/en/internals2/buildsys/configwin.xml:1.3 --- phpdoc/en/internals2/buildsys/configwin.xml:1.2 Wed Jun 20 22:39:08 2007 +++ phpdoc/en/internals2/buildsys/configwin.xml Thu Jun 28 04:45:10 2007 @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="ISO-8859-1"?> -<!-- $Revision: 1.2 $ --> - <sect1 xml:id="internals2.buildsys.configwin" xmlns="http://docbook.org/ns/docbook"> +<!-- $Revision: 1.3 $ --> + <sect1 xml:id="internals2.buildsys.configwin" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <title>Talking to the Windows build system: config.w32</title> <para> An extension's <filename>config.w32</filename> file is similar in usage to @@ -16,7 +16,7 @@ <title>An example config.w32 file</title> <programlisting role="javascript"> <![CDATA[ -// $Id: configwin.xml,v 1.2 2007/06/20 22:39:08 bjori Exp $ +// $Id: configwin.xml,v 1.3 2007/06/28 04:45:10 gwynne Exp $ // vim:ft=javascript ARG_WITH("example", "for example support", "no"); http://cvs.php.net/viewvc.cgi/phpdoc/en/internals2/buildsys/environment.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/internals2/buildsys/environment.xml diff -u phpdoc/en/internals2/buildsys/environment.xml:1.3 phpdoc/en/internals2/buildsys/environment.xml:1.4 --- phpdoc/en/internals2/buildsys/environment.xml:1.3 Wed Jun 20 22:39:08 2007 +++ phpdoc/en/internals2/buildsys/environment.xml Thu Jun 28 04:45:10 2007 @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="ISO-8859-1"?> -<!-- $Revision: 1.3 $ --> - <sect1 xml:id="internals2.buildsys.environment" xmlns="http://docbook.org/ns/docbook"> +<!-- $Revision: 1.4 $ --> + <sect1 xml:id="internals2.buildsys.environment" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <title>Building PHP for extension development</title> <para> In a typical PHP installation, the need for high performance almost always @@ -18,8 +18,8 @@ <literal>--enable-maintainer-zts</literal> options to <filename>configure</filename>, along with whatever options you typically use. For instructions on building PHP from source, see the instructions at - <link linkend="install.general">General Installation Considerations</link>. - A typical <filename>configure</filename> line might look like this: + <xref linkend="install.general"/>. A typical <filename>configure</filename> + line might look like this: <programlisting role="shell"> <![CDATA[ $ ./configure --prefix=/where/to/install/php --enable-debug --enable-maintainer-zts --enable-cgi --enable-cli --with-mysql=/path/to/mysql http://cvs.php.net/viewvc.cgi/phpdoc/en/internals2/buildsys/index.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/internals2/buildsys/index.xml diff -u phpdoc/en/internals2/buildsys/index.xml:1.3 phpdoc/en/internals2/buildsys/index.xml:1.4 --- phpdoc/en/internals2/buildsys/index.xml:1.3 Wed Jun 20 22:39:08 2007 +++ phpdoc/en/internals2/buildsys/index.xml Thu Jun 28 04:45:10 2007 @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="ISO-8859-1"?> -<!-- $Revision: 1.3 $ --> - <chapter xml:id="internals2.buildsys" xmlns="http://docbook.org/ns/docbook"> +<!-- $Revision: 1.4 $ --> + <chapter xml:id="internals2.buildsys" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <title>The PHP 5 build system</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/internals2/buildsys/skeleton.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/internals2/buildsys/skeleton.xml diff -u phpdoc/en/internals2/buildsys/skeleton.xml:1.2 phpdoc/en/internals2/buildsys/skeleton.xml:1.3 --- phpdoc/en/internals2/buildsys/skeleton.xml:1.2 Wed Jun 20 22:39:08 2007 +++ phpdoc/en/internals2/buildsys/skeleton.xml Thu Jun 28 04:45:10 2007 @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="ISO-8859-1"?> -<!-- $Revision: 1.2 $ --> - <sect1 xml:id="internals2.buildsys.skeleton" xmlns="http://docbook.org/ns/docbook"> +<!-- $Revision: 1.3 $ --> + <sect1 xml:id="internals2.buildsys.skeleton" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <title>The ext_skel script</title> <para> A Zend extension is composed of several files common to all extensions. As http://cvs.php.net/viewvc.cgi/phpdoc/en/internals2/ze1/streams/constants.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/internals2/ze1/streams/constants.xml diff -u phpdoc/en/internals2/ze1/streams/constants.xml:1.2 phpdoc/en/internals2/ze1/streams/constants.xml:1.3 --- phpdoc/en/internals2/ze1/streams/constants.xml:1.2 Wed Jun 20 22:39:08 2007 +++ phpdoc/en/internals2/ze1/streams/constants.xml Thu Jun 28 04:45:10 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Author: Wez Furlong <wez@thebrainroom.com> Please contact me before making any major amendments to the content of this section. Splitting/Merging are fine if they are @@ -8,157 +8,145 @@ --> <sect2 xml:id="internals2.ze1.streams.constants" xmlns="http://docbook.org/ns/docbook"> - <title>Streams Constants</title> + <title>Streams open options</title> - <refentry xml:id="internals2.ze1.streams.options"> - <refnamediv> - <refname>Stream open options</refname> - <refpurpose>Affects the operation of stream factory functions</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <para> - One or more of these values can be combined using the OR operator. - <variablelist> - <varlistentry> - <term> - <constant>IGNORE_PATH</constant> - </term> - <listitem> - <simpara> - This is the default option for streams; it requests that the include_path is - not to be searched for the requested file. - </simpara> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <constant>USE_PATH</constant> - </term> - <listitem> - <simpara> - Requests that the include_path is to be searched for the requested file. - </simpara> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <constant>IGNORE_URL</constant> - </term> - <listitem> - <simpara> - Requests that registered URL wrappers are to be ignored when opening the - stream. Other non-URL wrappers will be taken into consideration when - decoding the path. There is no opposite form for this flag; the streams - API will use all registered wrappers by default. - </simpara> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <constant>IGNORE_URL_WIN</constant> - </term> - <listitem> - <simpara> - On Windows systems, this is equivalent to IGNORE_URL. - On all other systems, this flag has no effect. - </simpara> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <constant>ENFORCE_SAFE_MODE</constant> - </term> - <listitem> - <simpara> - Requests that the underlying stream implementation perform safe_mode - checks on the file before opening the file. Omitting this flag will skip - safe_mode checks and allow opening of any file that the PHP process - has rights to access. - </simpara> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <constant>REPORT_ERRORS</constant> - </term> - <listitem> - <simpara> - If this flag is set, and there was an error during the opening of the file - or URL, the streams API will call the php_error function for you. This - is useful because the path may contain username/password information - that should not be displayed in the browser output (it would be a - security risk to do so). When the streams API raises the error, it first - strips username/password information from the path, making the error - message safe to display in the browser. - </simpara> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <constant>STREAM_MUST_SEEK</constant> - </term> - <listitem> - <simpara> - This flag is useful when your extension really must be able to randomly - seek around in a stream. Some streams may not be seekable in their - native form, so this flag asks the streams API to check to see if the - stream does support seeking. If it does not, it will copy the stream - into temporary storage (which may be a temporary file or a memory - stream) which does support seeking. - Please note that this flag is not useful when you want to seek the - stream and write to it, because the stream you are accessing might - not be bound to the actual resource you requested. - </simpara> - <note> - <simpara> - If the requested resource is network based, this flag will cause the - opener to block until the whole contents have been downloaded. - </simpara> - </note> - </listitem> - </varlistentry> - - <varlistentry> - <term> - <constant>STREAM_WILL_CAST</constant> - </term> - <listitem> - <simpara> - If your extension is using a third-party library that expects a FILE* or - file descriptor, you can use this flag to request the streams API to - open the resource but avoid buffering. You can then use - <function>php_stream_cast</function> to retrieve the FILE* or - file descriptor that the library requires. - </simpara> - <simpara> - The is particularly useful when accessing HTTP URLs where the start - of the actual stream data is found after an indeterminate offset into - the stream. - </simpara> - <simpara> - Since this option disables buffering at the streams API level, you - may experience lower performance when using streams functions - on the stream; this is deemed acceptable because you have told - streams that you will be using the functions to match the underlying - stream implementation. - Only use this option when you are sure you need it. - </simpara> - </listitem> - </varlistentry> - - - </variablelist> - </para> - </refsect1> - </refentry> - + <para> + These constants affect the operation of stream factory functions. + <variablelist> + <varlistentry> + <term> + <constant>IGNORE_PATH</constant> + </term> + <listitem> + <simpara> + This is the default option for streams; it requests that the include_path is + not to be searched for the requested file. + </simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <constant>USE_PATH</constant> + </term> + <listitem> + <simpara> + Requests that the include_path is to be searched for the requested file. + </simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <constant>IGNORE_URL</constant> + </term> + <listitem> + <simpara> + Requests that registered URL wrappers are to be ignored when opening the + stream. Other non-URL wrappers will be taken into consideration when + decoding the path. There is no opposite form for this flag; the streams + API will use all registered wrappers by default. + </simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <constant>IGNORE_URL_WIN</constant> + </term> + <listitem> + <simpara> + On Windows systems, this is equivalent to IGNORE_URL. + On all other systems, this flag has no effect. + </simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <constant>ENFORCE_SAFE_MODE</constant> + </term> + <listitem> + <simpara> + Requests that the underlying stream implementation perform safe_mode + checks on the file before opening the file. Omitting this flag will skip + safe_mode checks and allow opening of any file that the PHP process + has rights to access. + </simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <constant>REPORT_ERRORS</constant> + </term> + <listitem> + <simpara> + If this flag is set, and there was an error during the opening of the file + or URL, the streams API will call the php_error function for you. This + is useful because the path may contain username/password information + that should not be displayed in the browser output (it would be a + security risk to do so). When the streams API raises the error, it first + strips username/password information from the path, making the error + message safe to display in the browser. + </simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <constant>STREAM_MUST_SEEK</constant> + </term> + <listitem> + <simpara> + This flag is useful when your extension really must be able to randomly + seek around in a stream. Some streams may not be seekable in their + native form, so this flag asks the streams API to check to see if the + stream does support seeking. If it does not, it will copy the stream + into temporary storage (which may be a temporary file or a memory + stream) which does support seeking. + Please note that this flag is not useful when you want to seek the + stream and write to it, because the stream you are accessing might + not be bound to the actual resource you requested. + </simpara> + <note> + <simpara> + If the requested resource is network based, this flag will cause the + opener to block until the whole contents have been downloaded. + </simpara> + </note> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <constant>STREAM_WILL_CAST</constant> + </term> + <listitem> + <simpara> + If your extension is using a third-party library that expects a FILE* or + file descriptor, you can use this flag to request the streams API to + open the resource but avoid buffering. You can then use + <function>php_stream_cast</function> to retrieve the FILE* or + file descriptor that the library requires. + </simpara> + <simpara> + The is particularly useful when accessing HTTP URLs where the start + of the actual stream data is found after an indeterminate offset into + the stream. + </simpara> + <simpara> + Since this option disables buffering at the streams API level, you + may experience lower performance when using streams functions + on the stream; this is deemed acceptable because you have told + streams that you will be using the functions to match the underlying + stream implementation. + Only use this option when you are sure you need it. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> </sect2> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/internals2/ze1/streams/index.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/internals2/ze1/streams/index.xml diff -u phpdoc/en/internals2/ze1/streams/index.xml:1.2 phpdoc/en/internals2/ze1/streams/index.xml:1.3 --- phpdoc/en/internals2/ze1/streams/index.xml:1.2 Wed Jun 20 22:39:08 2007 +++ phpdoc/en/internals2/ze1/streams/index.xml Thu Jun 28 04:45:10 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Author: Wez Furlong <wez@thebrainroom.com> Please contact me before making any major amendments to the content of this section. Splitting/Merging are fine if they are @@ -285,12 +285,13 @@ a stream. To do this, you can use <function>php_stream_auto_cleanup</function>. </para> </sect2> - +<!-- Disable these until references are fixed &internals2.ze1.streams.common; &internals2.ze1.streams.dir; &internals2.ze1.streams.file; &internals2.ze1.streams.socket; &internals2.ze1.streams.structs; +--> &internals2.ze1.streams.constants; </sect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/internals2/ze1/tsrm/index.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/internals2/ze1/tsrm/index.xml diff -u phpdoc/en/internals2/ze1/tsrm/index.xml:1.2 phpdoc/en/internals2/ze1/tsrm/index.xml:1.3 --- phpdoc/en/internals2/ze1/tsrm/index.xml:1.2 Wed Jun 20 22:39:08 2007 +++ phpdoc/en/internals2/ze1/tsrm/index.xml Thu Jun 28 04:45:10 2007 @@ -1,12 +1,15 @@ <?xml version="1.0" encoding="ISO-8859-1" ?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <sect1 xml:id="internals2.ze1.tsrm" xmlns="http://docbook.org/ns/docbook"> <title>TSRM API</title> + <para/> +<!-- Disable these until references are fixed <sect2 xml:id="internals2.ze1.tsrm.api-reference"> <title>API Function and Macro reference (work in progress)</title> &internals2.ze1.tsrm.functions; &internals2.ze1.tsrm.macros; </sect2> +--> </sect1> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/internals2/ze1/zendapi/index.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/internals2/ze1/zendapi/index.xml diff -u phpdoc/en/internals2/ze1/zendapi/index.xml:1.2 phpdoc/en/internals2/ze1/zendapi/index.xml:1.3 --- phpdoc/en/internals2/ze1/zendapi/index.xml:1.2 Wed Jun 20 22:39:09 2007 +++ phpdoc/en/internals2/ze1/zendapi/index.xml Thu Jun 28 04:45:10 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="ISO-8859-1" ?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <sect1 xml:id="internals2.ze1.zendapi" xmlns="http://docbook.org/ns/docbook"> <title>&ZendAPI;</title> &internals2.ze1.zendapi.intro; @@ -22,11 +22,13 @@ &internals2.ze1.zendapi.where-to-go; &internals2.ze1.zendapi.configuration-macros; &internals2.ze1.zendapi.api-macros; +<!-- Disable these until references are fixed <sect2 xml:id="internals2.ze1.zendapi.reference"> <title>API Function and Macro reference (work in progress)</title> &internals2.ze1.zendapi.functions; &internals2.ze1.zendapi.macros; </sect2> +--> </sect1> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/internals2/ze1/zendapi/intro.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/internals2/ze1/zendapi/intro.xml diff -u phpdoc/en/internals2/ze1/zendapi/intro.xml:1.2 phpdoc/en/internals2/ze1/zendapi/intro.xml:1.3 --- phpdoc/en/internals2/ze1/zendapi/intro.xml:1.2 Wed Jun 20 22:39:09 2007 +++ phpdoc/en/internals2/ze1/zendapi/intro.xml Thu Jun 28 04:45:10 2007 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="ISO-8859-1" ?> - <!-- $Revision: 1.2 $ --> + <!-- $Revision: 1.3 $ --> <sect2 xml:id="internals2.ze1.zendapi.intro" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <title>Introduction</title> - <abstract> - <para>Those who know don't talk.</para> - <para>Those who talk don't know.</para> - </abstract> + + <para>Those who know don't talk.</para> + <para>Those who talk don't know.</para> + <para/> <para> Sometimes, PHP "as is" simply isn't enough. Although these cases are rare