cvs: phpdoc / TODO /en language-snippets.ent /en/functions ctype.xml dbx.xml domxml.xml fbsql.xml ingres_ii.xml mbstring.xml ming.xml openssl.xml
satellite.xml sockets.xml xslt.xml
| From: | Jeroen van Wolffelaar | Date: | Sun, 24 Jun 2001 15:27:22 +0000 |
| Subject: | cvs: phpdoc / TODO /en language-snippets.ent /en/functions ctype.xml dbx.xml domxml.xml fbsql.xml ingres_ii.xml mbstring.xml ming.xml openssl.xml satellite.xml sockets.xml xslt.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969335594@lists.php.net to get a copy of this message | ||
jeroen Sun Jun 24 17:27:22 2001 EDT
Modified files:
/phpdoc TODO
/phpdoc/en language-snippets.ent
/phpdoc/en/functions ctype.xml dbx.xml domxml.xml fbsql.xml
ingres_ii.xml mbstring.xml ming.xml
openssl.xml satellite.xml sockets.xml xslt.xml
Log:
Added a warning about the experimental status of some modules.
Updated TODO
Index: phpdoc/TODO diff -u phpdoc/TODO:1.1 phpdoc/TODO:1.2 --- phpdoc/TODO:1.1 Sun Jun 24 13:37:47 2001 +++ phpdoc/TODO Sun Jun 24 17:27:21 2001 @@ -7,11 +7,43 @@ URGENT: - - + - Note in sockets that the documentation is outdated, that + it has always been experimental (until 4.0.6, that is), + and that scripts that worked with PHP <= 4.0.5 will + definitely NOT work with 4.0.6 or above. Not only + has there been renaming, the way the funcs work also + changed dramatically. + - Check out wether there are more experimental modules, + and CLEARLY state so in the documentation. + + ( find php4 | grep EXPERIMENTAL : + ./ext/crack/EXPERIMENTAL + ./ext/ctype/EXPERIMENTAL + ./ext/dbx/EXPERIMENTAL + ./ext/domxml/EXPERIMENTAL + ./ext/dotnet/EXPERIMENTAL + ./ext/fbsql/EXPERIMENTAL + ./ext/iconv/EXPERIMENTAL + ./ext/ingres_ii/EXPERIMENTAL + ./ext/mailparse/EXPERIMENTAL + ./ext/mbstring/EXPERIMENTAL + ./ext/ming/EXPERIMENTAL + ./ext/muscat/EXPERIMENTAL + ./ext/ncurses/EXPERIMENTAL + ./ext/openssl/EXPERIMENTAL + ./ext/pcntl/EXPERIMENTAL + ./ext/qtdom/EXPERIMENTAL + ./ext/sablot/EXPERIMENTAL + ./ext/satellite/EXPERIMENTAL + ./ext/skeleton/EXPERIMENTAL + ./ext/sockets/EXPERIMENTAL + ./ext/vpopmail/EXPERIMENTAL + ./ext/xslt/EXPERIMENTAL + ) GENERAL: - - Document the diffs between add[c]slashes(). Maybe just document + - Document the diffs between strip[c]slashes(). Maybe just document for both of them what they do - exactly. - Add ¬e.no-safemode; to the bottom of each function that is disabled in safe-mode.' Index: phpdoc/en/language-snippets.ent diff -u phpdoc/en/language-snippets.ent:1.1 phpdoc/en/language-snippets.ent:1.2 --- phpdoc/en/language-snippets.ent:1.1 Sun Jun 24 13:45:37 2001 +++ phpdoc/en/language-snippets.ent Sun Jun 24 17:27:21 2001 @@ -1,3 +1,4 @@ +<!ENTITY warn.experimental '<warning><simpara>This module is <emphasis>EXPERIMENTAL</emphasis>. That means, that the behaviour of these functions, these function names, in concreto ANYTHING documented here can change in a future release of PHP WITHOUT NOTICE. Be warned, and use this module at your own risk.</simpara></warning>'> <!ENTITY tip.ob-capture '<tip><simpara>As with anything that outputs its result directly to the browser, you can use the <link linkend="ref.outcontrol">output-control functions</link> to capture the output of this function, and save it - for example - in a <type>string</type>.</simpara></tip>'> Index: phpdoc/en/functions/ctype.xml diff -u phpdoc/en/functions/ctype.xml:1.5 phpdoc/en/functions/ctype.xml:1.6 --- phpdoc/en/functions/ctype.xml:1.5 Thu May 17 14:40:57 2001 +++ phpdoc/en/functions/ctype.xml Sun Jun 24 17:27:21 2001 @@ -3,6 +3,7 @@ <titleabbrev>ctype</titleabbrev> <partintro> + &warn.experimental; <para> These functions check whether a character or string falls into a certain character class according to the Index: phpdoc/en/functions/dbx.xml diff -u phpdoc/en/functions/dbx.xml:1.11 phpdoc/en/functions/dbx.xml:1.12 --- phpdoc/en/functions/dbx.xml:1.11 Tue Jun 5 15:42:18 2001 +++ phpdoc/en/functions/dbx.xml Sun Jun 24 17:27:21 2001 @@ -2,6 +2,7 @@ <title>dbx functions</title> <titleabbrev>dbx</titleabbrev> <partintro> + &warn.experimental; <simpara> The dbx module is a database abstraction layer (db 'X', where 'X' is a supported database). The dbx functions allow you to access Index: phpdoc/en/functions/domxml.xml diff -u phpdoc/en/functions/domxml.xml:1.12 phpdoc/en/functions/domxml.xml:1.13 --- phpdoc/en/functions/domxml.xml:1.12 Sat Apr 28 09:38:45 2001 +++ phpdoc/en/functions/domxml.xml Sun Jun 24 17:27:21 2001 @@ -3,6 +3,7 @@ <titleabbrev>DOM XML</titleabbrev> <partintro> + &warn.experimental; <simpara> This documentation is not finished yet. Don't start to translate it or use it as a programming reference (steinm@php.net). Index: phpdoc/en/functions/fbsql.xml diff -u phpdoc/en/functions/fbsql.xml:1.10 phpdoc/en/functions/fbsql.xml:1.11 --- phpdoc/en/functions/fbsql.xml:1.10 Thu Jun 7 01:07:11 2001 +++ phpdoc/en/functions/fbsql.xml Sun Jun 24 17:27:21 2001 @@ -2,6 +2,7 @@ <title>FrontBase functions</title> <titleabbrev>FrontBase</titleabbrev> <partintro> + &warn.experimental; <simpara> These functions allow you to access FrontBase database servers. In order to have these functions available, you must compile php Index: phpdoc/en/functions/ingres_ii.xml diff -u phpdoc/en/functions/ingres_ii.xml:1.1 phpdoc/en/functions/ingres_ii.xml:1.2 --- phpdoc/en/functions/ingres_ii.xml:1.1 Mon Nov 20 18:25:32 2000 +++ phpdoc/en/functions/ingres_ii.xml Sun Jun 24 17:27:21 2001 @@ -2,6 +2,7 @@ <title>Ingres II functions</title> <titleabbrev>Ingres II</titleabbrev> <partintro> + &warn.experimental; <simpara> These functions allow you to access Ingres II database servers. </simpara> Index: phpdoc/en/functions/mbstring.xml diff -u phpdoc/en/functions/mbstring.xml:1.1 phpdoc/en/functions/mbstring.xml:1.2 --- phpdoc/en/functions/mbstring.xml:1.1 Sun May 20 09:43:42 2001 +++ phpdoc/en/functions/mbstring.xml Sun Jun 24 17:27:21 2001 @@ -2,6 +2,7 @@ <title>Multi-Byte String Functions</title> <titleabbrev>Multi-Byte String</titleabbrev> <partintro> + &warn.experimental; <sect1 id="mb-intro"> <title>Introduction</title> <warning> @@ -1399,4 +1400,4 @@ --> <!-- Keep this comment for vi/vim/gvim vi: et:ts=1:sw=1 - --> \ No newline at end of file + --> Index: phpdoc/en/functions/ming.xml diff -u phpdoc/en/functions/ming.xml:1.11 phpdoc/en/functions/ming.xml:1.12 --- phpdoc/en/functions/ming.xml:1.11 Wed May 16 20:33:21 2001 +++ phpdoc/en/functions/ming.xml Sun Jun 24 17:27:21 2001 @@ -3,6 +3,7 @@ <titleabbrev>Ming (flash)</titleabbrev> <partintro> + &warn.experimental; <sect1 id="ming.intro"> <title>Introduction</title> <simpara> Index: phpdoc/en/functions/openssl.xml diff -u phpdoc/en/functions/openssl.xml:1.8 phpdoc/en/functions/openssl.xml:1.9 --- phpdoc/en/functions/openssl.xml:1.8 Wed May 16 20:33:21 2001 +++ phpdoc/en/functions/openssl.xml Sun Jun 24 17:27:21 2001 @@ -2,6 +2,7 @@ <title>OpenSSL functions</title> <titleabbrev>OpenSSL</titleabbrev> <partintro> + &warn.experimental; <sect1 id="openssl.intro"> <title>Introduction</title> <para> Index: phpdoc/en/functions/satellite.xml diff -u phpdoc/en/functions/satellite.xml:1.4 phpdoc/en/functions/satellite.xml:1.5 --- phpdoc/en/functions/satellite.xml:1.4 Tue Sep 5 10:29:49 2000 +++ phpdoc/en/functions/satellite.xml Sun Jun 24 17:27:21 2001 @@ -1,6 +1,6 @@ <!-- - $Id: satellite.xml,v 1.4 2000/09/05 08:29:49 eriksson Exp $ + $Id: satellite.xml,v 1.5 2001/06/24 15:27:21 jeroen Exp $ Author: David Eriksson <david@2good.com> @@ -11,6 +11,7 @@ <titleabbrev>Satellite</titleabbrev> <partintro> + &warn.experimental; <para> The Satellite extension is used for accessing CORBA objects. You will need to set the idl_directory= entry in php.ini to a path Index: phpdoc/en/functions/sockets.xml diff -u phpdoc/en/functions/sockets.xml:1.10 phpdoc/en/functions/sockets.xml:1.11 --- phpdoc/en/functions/sockets.xml:1.10 Tue Jun 19 20:18:04 2001 +++ phpdoc/en/functions/sockets.xml Sun Jun 24 17:27:21 2001 @@ -3,6 +3,7 @@ <titleabbrev>Sockets</titleabbrev> <partintro> + &warn.experimental; <simpara> The socket extension implements a low-level interface to the socket communication functions, providing the possibility to act @@ -622,4 +623,4 @@ sgml-local-ecat-files:nil End: --> - \ No newline at end of file + Index: phpdoc/en/functions/xslt.xml diff -u phpdoc/en/functions/xslt.xml:1.15 phpdoc/en/functions/xslt.xml:1.16 --- phpdoc/en/functions/xslt.xml:1.15 Mon Mar 19 14:24:24 2001 +++ phpdoc/en/functions/xslt.xml Sun Jun 24 17:27:21 2001 @@ -4,6 +4,7 @@ <titleabbrev>XSLT</titleabbrev> <partintro> + &warn.experimental; <sect1 id="xslt.partintro"> <title>Introduction</title>
Index: phpdoc/TODO diff -u phpdoc/TODO:1.1 phpdoc/TODO:1.2 --- phpdoc/TODO:1.1 Sun Jun 24 13:37:47 2001 +++ phpdoc/TODO Sun Jun 24 17:27:21 2001 @@ -7,11 +7,43 @@ URGENT: - - + - Note in sockets that the documentation is outdated, that + it has always been experimental (until 4.0.6, that is), + and that scripts that worked with PHP <= 4.0.5 will + definitely NOT work with 4.0.6 or above. Not only + has there been renaming, the way the funcs work also + changed dramatically. + - Check out wether there are more experimental modules, + and CLEARLY state so in the documentation. + + ( find php4 | grep EXPERIMENTAL : + ./ext/crack/EXPERIMENTAL + ./ext/ctype/EXPERIMENTAL + ./ext/dbx/EXPERIMENTAL + ./ext/domxml/EXPERIMENTAL + ./ext/dotnet/EXPERIMENTAL + ./ext/fbsql/EXPERIMENTAL + ./ext/iconv/EXPERIMENTAL + ./ext/ingres_ii/EXPERIMENTAL + ./ext/mailparse/EXPERIMENTAL + ./ext/mbstring/EXPERIMENTAL + ./ext/ming/EXPERIMENTAL + ./ext/muscat/EXPERIMENTAL + ./ext/ncurses/EXPERIMENTAL + ./ext/openssl/EXPERIMENTAL + ./ext/pcntl/EXPERIMENTAL + ./ext/qtdom/EXPERIMENTAL + ./ext/sablot/EXPERIMENTAL + ./ext/satellite/EXPERIMENTAL + ./ext/skeleton/EXPERIMENTAL + ./ext/sockets/EXPERIMENTAL + ./ext/vpopmail/EXPERIMENTAL + ./ext/xslt/EXPERIMENTAL + ) GENERAL: - - Document the diffs between add[c]slashes(). Maybe just document + - Document the diffs between strip[c]slashes(). Maybe just document for both of them what they do - exactly. - Add ¬e.no-safemode; to the bottom of each function that is disabled in safe-mode.' Index: phpdoc/en/language-snippets.ent diff -u phpdoc/en/language-snippets.ent:1.1 phpdoc/en/language-snippets.ent:1.2 --- phpdoc/en/language-snippets.ent:1.1 Sun Jun 24 13:45:37 2001 +++ phpdoc/en/language-snippets.ent Sun Jun 24 17:27:21 2001 @@ -1,3 +1,4 @@ +<!ENTITY warn.experimental '<warning><simpara>This module is <emphasis>EXPERIMENTAL</emphasis>. That means, that the behaviour of these functions, these function names, in concreto ANYTHING documented here can change in a future release of PHP WITHOUT NOTICE. Be warned, and use this module at your own risk.</simpara></warning>'> <!ENTITY tip.ob-capture '<tip><simpara>As with anything that outputs its result directly to the browser, you can use the <link linkend="ref.outcontrol">output-control functions</link> to capture the output of this function, and save it - for example - in a <type>string</type>.</simpara></tip>'> Index: phpdoc/en/functions/ctype.xml diff -u phpdoc/en/functions/ctype.xml:1.5 phpdoc/en/functions/ctype.xml:1.6 --- phpdoc/en/functions/ctype.xml:1.5 Thu May 17 14:40:57 2001 +++ phpdoc/en/functions/ctype.xml Sun Jun 24 17:27:21 2001 @@ -3,6 +3,7 @@ <titleabbrev>ctype</titleabbrev> <partintro> + &warn.experimental; <para> These functions check whether a character or string falls into a certain character class according to the Index: phpdoc/en/functions/dbx.xml diff -u phpdoc/en/functions/dbx.xml:1.11 phpdoc/en/functions/dbx.xml:1.12 --- phpdoc/en/functions/dbx.xml:1.11 Tue Jun 5 15:42:18 2001 +++ phpdoc/en/functions/dbx.xml Sun Jun 24 17:27:21 2001 @@ -2,6 +2,7 @@ <title>dbx functions</title> <titleabbrev>dbx</titleabbrev> <partintro> + &warn.experimental; <simpara> The dbx module is a database abstraction layer (db 'X', where 'X' is a supported database). The dbx functions allow you to access Index: phpdoc/en/functions/domxml.xml diff -u phpdoc/en/functions/domxml.xml:1.12 phpdoc/en/functions/domxml.xml:1.13 --- phpdoc/en/functions/domxml.xml:1.12 Sat Apr 28 09:38:45 2001 +++ phpdoc/en/functions/domxml.xml Sun Jun 24 17:27:21 2001 @@ -3,6 +3,7 @@ <titleabbrev>DOM XML</titleabbrev> <partintro> + &warn.experimental; <simpara> This documentation is not finished yet. Don't start to translate it or use it as a programming reference (steinm@php.net). Index: phpdoc/en/functions/fbsql.xml diff -u phpdoc/en/functions/fbsql.xml:1.10 phpdoc/en/functions/fbsql.xml:1.11 --- phpdoc/en/functions/fbsql.xml:1.10 Thu Jun 7 01:07:11 2001 +++ phpdoc/en/functions/fbsql.xml Sun Jun 24 17:27:21 2001 @@ -2,6 +2,7 @@ <title>FrontBase functions</title> <titleabbrev>FrontBase</titleabbrev> <partintro> + &warn.experimental; <simpara> These functions allow you to access FrontBase database servers. In order to have these functions available, you must compile php Index: phpdoc/en/functions/ingres_ii.xml diff -u phpdoc/en/functions/ingres_ii.xml:1.1 phpdoc/en/functions/ingres_ii.xml:1.2 --- phpdoc/en/functions/ingres_ii.xml:1.1 Mon Nov 20 18:25:32 2000 +++ phpdoc/en/functions/ingres_ii.xml Sun Jun 24 17:27:21 2001 @@ -2,6 +2,7 @@ <title>Ingres II functions</title> <titleabbrev>Ingres II</titleabbrev> <partintro> + &warn.experimental; <simpara> These functions allow you to access Ingres II database servers. </simpara> Index: phpdoc/en/functions/mbstring.xml diff -u phpdoc/en/functions/mbstring.xml:1.1 phpdoc/en/functions/mbstring.xml:1.2 --- phpdoc/en/functions/mbstring.xml:1.1 Sun May 20 09:43:42 2001 +++ phpdoc/en/functions/mbstring.xml Sun Jun 24 17:27:21 2001 @@ -2,6 +2,7 @@ <title>Multi-Byte String Functions</title> <titleabbrev>Multi-Byte String</titleabbrev> <partintro> + &warn.experimental; <sect1 id="mb-intro"> <title>Introduction</title> <warning> @@ -1399,4 +1400,4 @@ --> <!-- Keep this comment for vi/vim/gvim vi: et:ts=1:sw=1 - --> \ No newline at end of file + --> Index: phpdoc/en/functions/ming.xml diff -u phpdoc/en/functions/ming.xml:1.11 phpdoc/en/functions/ming.xml:1.12 --- phpdoc/en/functions/ming.xml:1.11 Wed May 16 20:33:21 2001 +++ phpdoc/en/functions/ming.xml Sun Jun 24 17:27:21 2001 @@ -3,6 +3,7 @@ <titleabbrev>Ming (flash)</titleabbrev> <partintro> + &warn.experimental; <sect1 id="ming.intro"> <title>Introduction</title> <simpara> Index: phpdoc/en/functions/openssl.xml diff -u phpdoc/en/functions/openssl.xml:1.8 phpdoc/en/functions/openssl.xml:1.9 --- phpdoc/en/functions/openssl.xml:1.8 Wed May 16 20:33:21 2001 +++ phpdoc/en/functions/openssl.xml Sun Jun 24 17:27:21 2001 @@ -2,6 +2,7 @@ <title>OpenSSL functions</title> <titleabbrev>OpenSSL</titleabbrev> <partintro> + &warn.experimental; <sect1 id="openssl.intro"> <title>Introduction</title> <para> Index: phpdoc/en/functions/satellite.xml diff -u phpdoc/en/functions/satellite.xml:1.4 phpdoc/en/functions/satellite.xml:1.5 --- phpdoc/en/functions/satellite.xml:1.4 Tue Sep 5 10:29:49 2000 +++ phpdoc/en/functions/satellite.xml Sun Jun 24 17:27:21 2001 @@ -1,6 +1,6 @@ <!-- - $Id: satellite.xml,v 1.4 2000/09/05 08:29:49 eriksson Exp $ + $Id: satellite.xml,v 1.5 2001/06/24 15:27:21 jeroen Exp $ Author: David Eriksson <david@2good.com> @@ -11,6 +11,7 @@ <titleabbrev>Satellite</titleabbrev> <partintro> + &warn.experimental; <para> The Satellite extension is used for accessing CORBA objects. You will need to set the idl_directory= entry in php.ini to a path Index: phpdoc/en/functions/sockets.xml diff -u phpdoc/en/functions/sockets.xml:1.10 phpdoc/en/functions/sockets.xml:1.11 --- phpdoc/en/functions/sockets.xml:1.10 Tue Jun 19 20:18:04 2001 +++ phpdoc/en/functions/sockets.xml Sun Jun 24 17:27:21 2001 @@ -3,6 +3,7 @@ <titleabbrev>Sockets</titleabbrev> <partintro> + &warn.experimental; <simpara> The socket extension implements a low-level interface to the socket communication functions, providing the possibility to act @@ -622,4 +623,4 @@ sgml-local-ecat-files:nil End: --> - \ No newline at end of file + Index: phpdoc/en/functions/xslt.xml diff -u phpdoc/en/functions/xslt.xml:1.15 phpdoc/en/functions/xslt.xml:1.16 --- phpdoc/en/functions/xslt.xml:1.15 Mon Mar 19 14:24:24 2001 +++ phpdoc/en/functions/xslt.xml Sun Jun 24 17:27:21 2001 @@ -4,6 +4,7 @@ <titleabbrev>XSLT</titleabbrev> <partintro> + &warn.experimental; <sect1 id="xslt.partintro"> <title>Introduction</title>