PHP Documentation - Re: [PHP-DOC] update of ini.xml files

Author

Re: [PHP-DOC] update of ini.xml files

Hannes Magnusson

2007-10-01, 8:00 am

On 9/30/07, Nuno Lopes <nlopess@php.net> wrote:
> Hi,
>
> During the last w

I've commited many changes to a few ini.xml files. One
> of those commits didn't even appeared in the ML because it was very large.
> I would like to ask you to review all those changes because the ini.xml
> updater script has been partially rewritten and some bugs may still exist.
> If you find any problem, please report it to me.

Sorry for the illogical reading of the below patches, I was diffing it
from the new-ref-struct branch :)

diff -u -p -r1.5 -r1.4
--- reference/yaz/ini.xml 28 Sep 2007 19:52:39 -0000 1.5
+++ reference/yaz/ini.xml 20 Jun 2007 22:25:38 -0000 1.4
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-
+
<section xml:id="yaz.configuration" xmlns="http://docbook.org/ns/docbook">
&reftitle.runtime;
&extension.runtime;
@@ -20,13 +20,13 @@
<entry>yaz.max_links</entry>
<entry>"100"</entry>
<entry>PHP_INI_ALL</entry>
- <entry>Available since PHP 4.3.0. Removed in PHP 5.0.0.</entry>
+ <entry>Available since PHP 4.3.0.</entry>
</row>
<row>
<entry>yaz.log_file</entry>
<entry>NULL</entry>
<entry>PHP_INI_ALL</entry>
- <entry>Available since PHP 4.3.0. Removed in PHP 5.0.0.</entry>
+ <entry>Available since PHP 4.3.0.</entry>
</row>
</tbody>
</tgroup>

Although the extension was removed in 5.0 I think the extension still
uses those ini entries.
The same applies to reference/pfpro/ini.xml,
reference/ingres-ii/ini.xml, reference/ifx/ini.xml,
reference/hw/ini.xml, reference/fbsql/ini.xml, reference/dbx/ini.xml,
reference/crack/ini.xml,

diff -u -p -r1.9 -r1.8
--- reference/tidy/ini.xml 29 Sep 2007 22:54:33 -0000 1.9
+++ reference/tidy/ini.xml 20 Jun 2007 22:25:32 -0000 1.8
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-
+
<section xml:id="tidy.configuration" xmlns="http://docbook.org/ns/docbook">
&reftitle.runtime;
&extension.runtime;
@@ -25,8 +25,8 @@
<row>
<entry>tidy.clean_output</entry>
<entry>"0"</entry>
- <entry>PHP_INI_USER</entry>
- <entry>PHP_INI_PERDIR in PHP 5. Available since PHP 5.0.0.</entry>
+ <entry>PHP_INI_PERDIR</entry>
+ <entry>Available since PHP 5.0.0.</entry>
</row>
</tbody>
</tgroup>

What is PHP_INI_USER? And if the entry is available since PHP5, when
was it PHP_INI_PERDIR?

diff -u -p -r1.20 -r1.18
--- reference/sybase/ini.xml 29 Sep 2007 22:54:33 -0000 1.20
+++ reference/sybase/ini.xml 20 Jun 2007 22:25:31 -0000 1.18
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-
+
<section xml:id="sybase.configuration" xmlns="http://docbook.org/ns/docbook">
&reftitle.runtime;
&extension.runtime;
@@ -62,7 +62,7 @@
<entry>magic_quotes_sybase</entry>
<entry>"0"</entry>
<entry>PHP_INI_ALL</entry>
- <entry>Removed in PHP 6.0.0.</entry>
+ <entry></entry>
</row>
</tbody>
</tgroup>
@@ -198,37 +198,37 @@
<entry>sybct.allow_persistent</entry>
<entry>"1"</entry>
<entry>PHP_INI_SYSTEM</entry>
- <entry>PHP_INI_ALL in PHP <= 4.0.2. Available since PHP
4.0.2. Removed in PHP 4.0.3.</entry>
+ <entry>PHP_INI_ALL in PHP <= 4.0.2. Available since PHP 4.0.2.</entry>
</row>

It was PHP_INI_ALL in less than 4.0.2 - but it didn't exist until 4.0.2? :)
(a couple of more same cases in this file)

diff -u -p -r1.6 -r1.5
--- reference/pdo_odbc/ini.xml 29 Sep 2007 22:54:33 -0000 1.6
+++ reference/pdo_odbc/ini.xml 20 Jun 2007 22:25:12 -0000 1.5
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-
+
<section xml:id="pdo_odbc.configuration" xmlns="http://docbook.org/ns/docbook">
&reftitle.runtime;
&extension.runtime;
@@ -24,9 +24,9 @@
</row>
<row>
<entry>pdo_odbc.db2_instance_name</entry>
- <entry>NULL</entry>
+ <entry>&null;</entry>
<entry>PHP_INI_SYSTEM</entry>
- <entry>Available since PHP 5.1.1. Removed in PHP 6.0.0.</entry>
+ <entry></entry>
</row>
</tbody>
</tgroup>

This is definitely wrong

diff -u -p -r1.12 -r1.11
--- reference/mail/ini.xml 28 Sep 2007 22:24:18 -0000 1.12
+++ reference/mail/ini.xml 20 Jun 2007 22:24:49 -0000 1.11
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-
+
<section xml:id="mail.configuration"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.runtime;
&extension.runtime;
@@ -36,7 +36,7 @@
</row>
<row>
<entry>sendmail_path</entry>
- <entry>"/usr/sbin/sendmail -t -i"</entry>
+ <entry>NULL</entry>
<entry>PHP_INI_SYSTEM</entry>
<entry></entry>
</row>
I don't think this has always been the default value..

diff -u -p -r1.20 -r1.19
--- reference/info/ini.xml 29 Sep 2007 22:54:33 -0000 1.20
+++ reference/info/ini.xml 17 Aug 2007 11:03:28 -0000 1.19
@@ -1,5 +1,5 @@
[snip]
<row>
<entry>max_input_nesting_level</entry>
<entry>"64"</entry>
- <entry>PHP_INI_PERDIR</entry>
- <entry>Available since PHP 4.4.8. Removed in PHP 5.0.0.</entry>
+ <entry>PHP_INI_SYSTEM|PHP_INI_PERDIR</entry>
+ <entry>Available since PHP 5.2.2 and 4.4.8. Note that the default value
+ in PHP 4.4.x is 500.</entry>
</row>

I think we should keep the note...

diff -u -p -r1.16 -r1.14
--- reference/filesystem/ini.xml 29 Sep 2007 22:54:33 -0000 1.16
+++ reference/filesystem/ini.xml 20 Jun 2007 22:24:27 -0000 1.14
[snip]
<row>
<entry>allow_url_include</entry>
<entry>"0"</entry>
- <entry>PHP_INI_ALL</entry>
- <entry>PHP_INI_SYSTEM in PHP 5. Available since PHP 5.2.0.</entry>
+ <entry>PHP_INI_SYSTEM</entry>
+ <entry>Available since PHP 5.2.0.</entry>
</row>
<row>
<entry>user_agent</entry>

PHP_INI_SYSTEM in PHP5 but only available since 5.2?

diff -u -p -r1.16 -r1.14
--- reference/apc/ini.xml 29 Sep 2007 22:54:33 -0000 1.16
+++ reference/apc/ini.xml 17 Aug 2007 16:49:52 -0000 1.14
[snip]
<entry>apc.enabled</entry>
<entry>"1"</entry>
<entry>PHP_INI_SYSTEM</entry>
- <entry>PHP_INI_SYSTEM in APC 2. PHP_INI_ALL in APC <= 3.0.12.</entry>
+ <entry>PHP_INI_ALL in APC <= 3.0.12p2</entry>
</row>
<row>

This is confusing, is it PHP_INI_SYSTEM again in 3.0.13 and later?
apc.cache_by_default has this weirdness too.

<row>
<entry>apc.rfc1867_prefix</entry>
<entry>"upload_"</entry>
<entry>PHP_INI_SYSTEM</entry>
- <entry></entry>
+ <entry>>= APC 3.0.15</entry>
</row>

(and the rest of the apc. entries)
Why was the version info removed?

I don't have the time to look into appendices/ini.xml but quickly
looking at the patch it looks like there was crazy amount of entries
simply removed, I doubt that is correct.

-Hannes

Nuno Lopes

2007-10-01, 8:00 am

> Sorry for the illogical reading of the below patches, I was diffing it
> from the new-ref-struct branch :)

ok, np ;)

> @@ -20,13 +20,13 @@
> <entry>yaz.max_links</entry>
> <entry>"100"</entry>
> <entry>PHP_INI_ALL</entry>
> - <entry>Available since PHP 4.3.0. Removed in PHP 5.0.0.</entry>
> + <entry>Available since PHP 4.3.0.</entry>
> </row>
>
> Although the extension was removed in 5.0 I think the extension still
> uses those ini entries.
> The same applies to reference/pfpro/ini.xml,
> reference/ingres-ii/ini.xml, reference/ifx/ini.xml,
> reference/hw/ini.xml, reference/fbsql/ini.xml, reference/dbx/ini.xml,
> reference/crack/ini.xml,

Well this is a matter of taste. That ini option was removed rom PHP 5, that
right. But it still exists in PECL.. I don't have a strong opinion here, so
just tell me how the output should look like and I'll tune it accordingly.

> @@ -25,8 +25,8 @@
> <row>
> <entry>tidy.clean_output</entry>
> <entry>"0"</entry>
> - <entry>PHP_INI_USER</entry>
> - <entry>PHP_INI_PERDIR in PHP 5. Available since PHP 5.0.0.</entry>
> + <entry>PHP_INI_PERDIR</entry>
> + <entry>Available since PHP 5.0.0.</entry>
> </row>

> What is PHP_INI_USER? And if the entry is available since PHP5, when
> was it PHP_INI_PERDIR?

I'm aware of this one. It is PHP_INI_USER in HEAD (dunno why). The code
needs to be changed (I need to talk with Mike first).

> @@ -198,37 +198,37 @@
> <entry>sybct.allow_persistent</entry>
> <entry>"1"</entry>
> <entry>PHP_INI_SYSTEM</entry>
> - <entry>PHP_INI_ALL in PHP <= 4.0.2. Available since PHP
> 4.0.2. Removed in PHP 4.0.3.</entry>
> + <entry>PHP_INI_ALL in PHP <= 4.0.2. Available since PHP
> 4.0.2.</entry>
> </row>
>
> It was PHP_INI_ALL in less than 4.0.2 - but it didn't exist until 4.0.2?
> :)
> (a couple of more same cases in this file)

It existed in 4.0.2 and it as PHP_INI_ALL. but then it was changed to
PHP_INI_SYSTEM in 4.0.4.
Also, this option didn't only exist in PHP 4.0.3... this one is very
strange.. Maybe I can inject the 4.0.3 version and hope that noone will
notice that it wasn't present in 4.0.3 :P

> @@ -24,9 +24,9 @@
> </row>
> <row>
> <entry>pdo_odbc.db2_instance_name</entry>
> - <entry>NULL</entry>
> + <entry>&null;</entry>
> <entry>PHP_INI_SYSTEM</entry>
> - <entry>Available since PHP 5.1.1. Removed in PHP 6.0.0.</entry>
> + <entry></entry>
> </row>
> </tbody>
> </tgroup>
>
> This is definitely wrong

I'll check it out.

> @@ -36,7 +36,7 @@
> </row>
> <row>
> <entry>sendmail_path</entry>
> - <entry>"/usr/sbin/sendmail -t -i"</entry>
> + <entry>NULL</entry>
> <entry>PHP_INI_SYSTEM</entry>
> <entry></entry>
> </row>
> I don't think this has always been the default value..

Yep, but the changelog doesn't include the default..

> diff -u -p -r1.20 -r1.19
> --- reference/info/ini.xml 29 Sep 2007 22:54:33 -0000 1.20
> +++ reference/info/ini.xml 17 Aug 2007 11:03:28 -0000 1.19
> @@ -1,5 +1,5 @@
> [snip]
> <row>
> <entry>max_input_nesting_level</entry>
> <entry>"64"</entry>
> - <entry>PHP_INI_PERDIR</entry>
> - <entry>Available since PHP 4.4.8. Removed in PHP 5.0.0.</entry>
> + <entry>PHP_INI_SYSTEM|PHP_INI_PERDIR</entry>
> + <entry>Available since PHP 5.2.2 and 4.4.8. Note that the default
> value
> + in PHP 4.4.x is 500.</entry>
> </row>
>
> I think we should keep the note...

OK, I'll revert that manually.

> <row>
> <entry>allow_url_include</entry>
> <entry>"0"</entry>
> - <entry>PHP_INI_ALL</entry>
> - <entry>PHP_INI_SYSTEM in PHP 5. Available since PHP 5.2.0.</entry>
> + <entry>PHP_INI_SYSTEM</entry>
> + <entry>Available since PHP 5.2.0.</entry>
> </row>
> <row>
> <entry>user_agent</entry>
>
> PHP_INI_SYSTEM in PHP5 but only available since 5.2?

damn.. that wasn't supposed to happen. Even so, I don't think the output is
that bad.. Saying it was x in PHP 5 means that it was changed in 6.. I'll
think more on this one.

> <entry>apc.enabled</entry>
> <entry>"1"</entry>
> <entry>PHP_INI_SYSTEM</entry>
> - <entry>PHP_INI_SYSTEM in APC 2. PHP_INI_ALL in APC <=
> 3.0.12.</entry>
> + <entry>PHP_INI_ALL in APC <= 3.0.12p2</entry>
> </row>
> <row>
>
> This is confusing, is it PHP_INI_SYSTEM again in 3.0.13 and later?
> apc.cache_by_default has this weirdness too.

yep. it was changed 3 times :P

> <row>
> <entry>apc.rfc1867_prefix</entry>
> <entry>"upload_"</entry>
> <entry>PHP_INI_SYSTEM</entry>
> - <entry></entry>
> + <entry>>= APC 3.0.15</entry>
> </row>
>
> (and the rest of the apc. entries)
> Why was the version info removed?

Probably because the opt already existed in APC 1. I'll investigate this one
too.

> I don't have the time to look into appendices/ini.xml but quickly
> looking at the patch it looks like there was crazy amount of entries
> simply removed, I doubt that is correct.

Uhm.. I'll check it out again.

Thanks Hannes!
Nuno

Sponsored Links