[DOC-CVS] [doc-en] master: bzip2: fix XML to remove useless wrapping para tags via script
[email protected] (Gina Peter Banyard)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Gina Peter Banyard (Girgias)
Date: 2026-01-25T15:16:20Z
Commit: https://github.com/php/doc-en/commit/b621a6e473bc13afb6a0f50f73318178f81df2e3
Raw diff: https://github.com/php/doc-en/commit/b621a6e473bc13afb6a0f50f73318178f81df2e3.diff
bzip2: fix XML to remove useless wrapping para tags via script
Changed paths:
M reference/bzip2/functions/bzclose.xml
M reference/bzip2/functions/bzcompress.xml
M reference/bzip2/functions/bzdecompress.xml
M reference/bzip2/functions/bzerrno.xml
M reference/bzip2/functions/bzerror.xml
M reference/bzip2/functions/bzerrstr.xml
M reference/bzip2/functions/bzflush.xml
M reference/bzip2/functions/bzopen.xml
M reference/bzip2/functions/bzread.xml
M reference/bzip2/functions/bzwrite.xml
Diff:
diff --git a/reference/bzip2/functions/bzclose.xml b/reference/bzip2/functions/bzclose.xml
index d7440317937a..8d7892b0976d 100644
--- a/reference/bzip2/functions/bzclose.xml
+++ b/reference/bzip2/functions/bzclose.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.bzclose" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.bzclose">
<refnamediv>
<refname>bzclose</refname>
<refpurpose>Close a bzip2 file</refpurpose>
@@ -17,19 +17,17 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>bz</parameter></term>
- <listitem>
- <para>
- The file pointer. It must be valid and must point to a file
- successfully opened by <function>bzopen</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>bz</parameter></term>
+ <listitem>
+ <para>
+ The file pointer. It must be valid and must point to a file
+ successfully opened by <function>bzopen</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -39,14 +37,11 @@
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzopen</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>bzopen</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/bzip2/functions/bzcompress.xml b/reference/bzip2/functions/bzcompress.xml
index 0a4c91720f0e..4cac3a8695da 100644
--- a/reference/bzip2/functions/bzcompress.xml
+++ b/reference/bzip2/functions/bzcompress.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.bzcompress" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.bzcompress">
<refnamediv>
<refname>bzcompress</refname>
<refpurpose>Compress a string into bzip2 encoded data</refpurpose>
@@ -20,42 +20,40 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>data</parameter></term>
- <listitem>
- <para>
- The string to compress.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>block_size</parameter></term>
- <listitem>
- <para>
- Specifies the blocksize used during compression and should be a number
- from 1 to 9 with 9 giving the best compression, but using more
- resources to do so.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>work_factor</parameter></term>
- <listitem>
- <para>
- Controls how the compression phase behaves when presented with worst
- case, highly repetitive, input data. The value can be between 0 and
- 250 with 0 being a special case.
- </para>
- <para>
- Regardless of the <parameter>work_factor</parameter>, the generated
- output is the same.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>data</parameter></term>
+ <listitem>
+ <para>
+ The string to compress.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>block_size</parameter></term>
+ <listitem>
+ <para>
+ Specifies the blocksize used during compression and should be a number
+ from 1 to 9 with 9 giving the best compression, but using more
+ resources to do so.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>work_factor</parameter></term>
+ <listitem>
+ <para>
+ Controls how the compression phase behaves when presented with worst
+ case, highly repetitive, input data. The value can be between 0 and
+ 250 with 0 being a special case.
+ </para>
+ <para>
+ Regardless of the <parameter>work_factor</parameter>, the generated
+ output is the same.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -80,11 +78,9 @@ echo $bzstr;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzdecompress</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>bzdecompress</function></member>
+ </simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
diff --git a/reference/bzip2/functions/bzdecompress.xml b/reference/bzip2/functions/bzdecompress.xml
index dbc9a55beddd..3041e03b4168 100644
--- a/reference/bzip2/functions/bzdecompress.xml
+++ b/reference/bzip2/functions/bzdecompress.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.bzdecompress" 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="function.bzdecompress">
<refnamediv>
<refname>bzdecompress</refname>
<refpurpose>Decompresses bzip2 encoded data</refpurpose>
@@ -19,32 +19,30 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>data</parameter></term>
- <listitem>
- <para>
- The string to decompress.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>use_less_memory</parameter></term>
- <listitem>
- <para>
- If &true;, an alternative decompression algorithm will be used which
- uses less memory (the maximum memory requirement drops to around 2300K)
- but works at roughly half the speed.
- </para>
- <para>
- See the <link xlink:href="&url.bzip2;">bzip2 documentation</link> for more
- information about this feature.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>data</parameter></term>
+ <listitem>
+ <para>
+ The string to decompress.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>use_less_memory</parameter></term>
+ <listitem>
+ <para>
+ If &true;, an alternative decompression algorithm will be used which
+ uses less memory (the maximum memory requirement drops to around 2300K)
+ but works at roughly half the speed.
+ </para>
+ <para>
+ See the <link xlink:href="&url.bzip2;">bzip2 documentation</link> for more
+ information about this feature.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -79,10 +77,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Decompressing a String</title>
- <programlisting role="php">
+ <example>
+ <title>Decompressing a String</title>
+ <programlisting role="php">
<![CDATA[
<?php
$start_str = "This is not an honest face?";
@@ -98,17 +95,14 @@ echo $str;
echo "\n<br />\n";
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzcompress</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>bzcompress</function></member>
+ </simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
diff --git a/reference/bzip2/functions/bzerrno.xml b/reference/bzip2/functions/bzerrno.xml
index d7605a6eacc4..52b3d64f8895 100644
--- a/reference/bzip2/functions/bzerrno.xml
+++ b/reference/bzip2/functions/bzerrno.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.bzerrno" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.bzerrno">
<refnamediv>
<refname>bzerrno</refname>
<refpurpose>Returns a bzip2 error number</refpurpose>
@@ -18,19 +18,17 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>bz</parameter></term>
- <listitem>
- <para>
- The file pointer. It must be valid and must point to a file
- successfully opened by <function>bzopen</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>bz</parameter></term>
+ <listitem>
+ <para>
+ The file pointer. It must be valid and must point to a file
+ successfully opened by <function>bzopen</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -40,15 +38,12 @@
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzerror</function></member>
- <member><function>bzerrstr</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>bzerror</function></member>
+ <member><function>bzerrstr</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/bzip2/functions/bzerror.xml b/reference/bzip2/functions/bzerror.xml
index bfc4b358abd7..d0a3c40c032e 100644
--- a/reference/bzip2/functions/bzerror.xml
+++ b/reference/bzip2/functions/bzerror.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.bzerror" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.bzerror">
<refnamediv>
<refname>bzerror</refname>
<refpurpose>
@@ -14,40 +14,37 @@
<methodparam><type>resource</type><parameter>bz</parameter></methodparam>
</methodsynopsis>
<para>
- Returns the error number and error string of any bzip2 error returned by
+ Returns the error number and error string of any bzip2 error returned by
the given file pointer.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>bz</parameter></term>
- <listitem>
- <para>
- The file pointer. It must be valid and must point to a file
- successfully opened by <function>bzopen</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>bz</parameter></term>
+ <listitem>
+ <para>
+ The file pointer. It must be valid and must point to a file
+ successfully opened by <function>bzopen</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns an associative array, with the error code in the
+ Returns an associative array, with the error code in the
<literal>errno</literal> entry, and the error message in the
<literal>errstr</literal> entry.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>bzerror</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>bzerror</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$error = bzerror($bz);
@@ -56,21 +53,17 @@ echo $error["errno"];
echo $error["errstr"];
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzerrno</function></member>
- <member><function>bzerrstr</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>bzerrno</function></member>
+ <member><function>bzerrstr</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/bzip2/functions/bzerrstr.xml b/reference/bzip2/functions/bzerrstr.xml
index 40ea80714237..6e6b386dcea6 100644
--- a/reference/bzip2/functions/bzerrstr.xml
+++ b/reference/bzip2/functions/bzerrstr.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.bzerrstr" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.bzerrstr">
<refnamediv>
<refname>bzerrstr</refname>
<refpurpose>Returns a bzip2 error string</refpurpose>
@@ -18,19 +18,17 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>bz</parameter></term>
- <listitem>
- <para>
- The file pointer. It must be valid and must point to a file
- successfully opened by <function>bzopen</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>bz</parameter></term>
+ <listitem>
+ <para>
+ The file pointer. It must be valid and must point to a file
+ successfully opened by <function>bzopen</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -40,15 +38,12 @@
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzerrno</function></member>
- <member><function>bzerror</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>bzerrno</function></member>
+ <member><function>bzerror</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/bzip2/functions/bzflush.xml b/reference/bzip2/functions/bzflush.xml
index 5409f9281aaf..53f95af27a0b 100644
--- a/reference/bzip2/functions/bzflush.xml
+++ b/reference/bzip2/functions/bzflush.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.bzflush" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.bzflush">
<refnamediv>
<refname>bzflush</refname>
<refpurpose>Do nothing</refpurpose>
@@ -19,19 +19,17 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>bz</parameter></term>
- <listitem>
- <para>
- The file pointer. It must be valid and must point to a file
- successfully opened by <function>bzopen</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>bz</parameter></term>
+ <listitem>
+ <para>
+ The file pointer. It must be valid and must point to a file
+ successfully opened by <function>bzopen</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -41,15 +39,12 @@
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzread</function></member>
- <member><function>bzwrite</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>bzread</function></member>
+ <member><function>bzwrite</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/bzip2/functions/bzopen.xml b/reference/bzip2/functions/bzopen.xml
index 37a3351d762b..a7b738f764d4 100644
--- a/reference/bzip2/functions/bzopen.xml
+++ b/reference/bzip2/functions/bzopen.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.bzopen" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.bzopen">
<refnamediv>
<refname>bzopen</refname>
<refpurpose>Opens a bzip2 compressed file</refpurpose>
@@ -19,27 +19,25 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>file</parameter></term>
- <listitem>
- <para>
- The name of the file to open, or an existing stream resource.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>mode</parameter></term>
- <listitem>
- <para>
- The modes <literal>'r'</literal> (read), and <literal>'w'</literal> (write) are supported.
- Everything else will cause <function>bzopen</function> to return &false;.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>file</parameter></term>
+ <listitem>
+ <para>
+ The name of the file to open, or an existing stream resource.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ <para>
+ The modes <literal>'r'</literal> (read), and <literal>'w'</literal> (write) are supported.
+ Everything else will cause <function>bzopen</function> to return &false;.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -50,10 +48,9 @@
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>bzopen</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>bzopen</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -64,17 +61,14 @@ bzclose($bz);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzclose</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>bzclose</function></member>
+ </simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
diff --git a/reference/bzip2/functions/bzread.xml b/reference/bzip2/functions/bzread.xml
index f6ad02bdf183..15bf03b900d8 100644
--- a/reference/bzip2/functions/bzread.xml
+++ b/reference/bzip2/functions/bzread.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.bzread" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.bzread">
<refnamediv>
<refname>bzread</refname>
<refpurpose>Binary safe bzip2 file read</refpurpose>
@@ -17,34 +17,32 @@
</para>
<para>
Reading stops when <parameter>length</parameter> (uncompressed) bytes have
- been read or EOF is reached, whichever comes first.
+ been read or EOF is reached, whichever comes first.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>bz</parameter></term>
- <listitem>
- <para>
- The file pointer. It must be valid and must point to a file
- successfully opened by <function>bzopen</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>length</parameter></term>
- <listitem>
- <para>
- If not specified, <function>bzread</function> will read 1024
- (uncompressed) bytes at a time. A maximum of 8192
- uncompressed bytes will be read at a time.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>bz</parameter></term>
+ <listitem>
+ <para>
+ The file pointer. It must be valid and must point to a file
+ successfully opened by <function>bzopen</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>length</parameter></term>
+ <listitem>
+ <para>
+ If not specified, <function>bzread</function> will read 1024
+ (uncompressed) bytes at a time. A maximum of 8192
+ uncompressed bytes will be read at a time.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -54,10 +52,9 @@
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>bzread</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>bzread</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -75,19 +72,16 @@ echo $decompressed_file;
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzwrite</function></member>
- <member><function>feof</function></member>
- <member><function>bzopen</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>bzwrite</function></member>
+ <member><function>feof</function></member>
+ <member><function>bzopen</function></member>
+ </simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
diff --git a/reference/bzip2/functions/bzwrite.xml b/reference/bzip2/functions/bzwrite.xml
index 2392d22a2e20..04d201ed8e9b 100644
--- a/reference/bzip2/functions/bzwrite.xml
+++ b/reference/bzip2/functions/bzwrite.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.bzwrite" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.bzwrite">
<refnamediv>
<refname>bzwrite</refname>
<refpurpose>Binary safe bzip2 file write</refpurpose>
@@ -14,43 +14,41 @@
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
- <function>bzwrite</function> writes a string into the given bzip2 file
+ <function>bzwrite</function> writes a string into the given bzip2 file
stream.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>bz</parameter></term>
- <listitem>
- <para>
- The file pointer. It must be valid and must point to a file
- successfully opened by <function>bzopen</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>data</parameter></term>
- <listitem>
- <para>
- The written data.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>length</parameter></term>
- <listitem>
- <para>
- If supplied, writing will stop after <parameter>length</parameter>
- (uncompressed) bytes have been written or the end of
- <parameter>data</parameter> is reached, whichever comes first.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>bz</parameter></term>
+ <listitem>
+ <para>
+ The file pointer. It must be valid and must point to a file
+ successfully opened by <function>bzopen</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>data</parameter></term>
+ <listitem>
+ <para>
+ The written data.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>length</parameter></term>
+ <listitem>
+ <para>
+ If supplied, writing will stop after <parameter>length</parameter>
+ (uncompressed) bytes have been written or the end of
+ <parameter>data</parameter> is reached, whichever comes first.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -83,10 +81,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>bzwrite</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>bzwrite</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$str = "uncompressed data";
@@ -95,18 +92,15 @@ bzwrite($bz, $str, strlen($str));
bzclose($bz);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>bzread</function></member>
- <member><function>bzopen</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>bzread</function></member>
+ <member><function>bzopen</function></member>
+ </simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file