[DOC-CVS] [doc-en] master: eio: fix XML to get remove of useless wrapping para tags
[email protected] (Gina Peter Banyard)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Gina Peter Banyard (Girgias)
Date: 2026-01-15T22:14:14Z
Commit: https://github.com/php/doc-en/commit/3ae6fd023622fc1f5198b63b3e002b41c106f012
Raw diff: https://github.com/php/doc-en/commit/3ae6fd023622fc1f5198b63b3e002b41c106f012.diff
eio: fix XML to get remove of useless wrapping para tags
Changed paths:
M reference/eio/examples.xml
M reference/eio/functions/eio-readdir.xml
Diff:
diff --git a/reference/eio/examples.xml b/reference/eio/examples.xml
index c9da451b2ee7..8560167c2187 100644
--- a/reference/eio/examples.xml
+++ b/reference/eio/examples.xml
@@ -1,13 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<chapter xml:id="eio.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="eio.examples">
&reftitle.examples;
- <para>
<example>
- <title>Cancelling a request</title>
- <programlisting role="php">
- <![CDATA[
+<title>Cancelling a request</title>
+<programlisting role="php">
+<![CDATA[
<?php
/* Is called when eio_nop() finished */
function my_nop_cb($data, $result) {
@@ -29,19 +27,17 @@ eio_event_loop();
</programlisting>
&example.outputs.similar;
<screen>
- <![CDATA[
+<![CDATA[
resource(4) of type (EIO Request Descriptor)
my_nop 2
]]>
- </screen>
- </example>
- </para>
+</screen>
+</example>
- <para>
<example>
- <title>Calling <function>eio_chmod</function></title>
- <programlisting role="php">
- <![CDATA[
+<title>Calling <function>eio_chmod</function></title>
+<programlisting role="php">
+<![CDATA[
<?php
$temp_filename = dirname(__FILE__) ."/eio-temp-file.tmp";
touch($temp_filename);
@@ -64,18 +60,16 @@ eio_event_loop();
</programlisting>
&example.outputs.similar;
<screen>
- <![CDATA[
+<![CDATA[
eio_chmod_ok
]]>
- </screen>
- </example>
- </para>
+</screen>
+</example>
- <para>
<example>
- <title>Making a custom request</title>
- <programlisting role="php">
- <![CDATA[
+<title>Making a custom request</title>
+<programlisting role="php">
+<![CDATA[
<?php
/* Callback for the custom callback */
function my_custom_callback($data, $result) {
@@ -106,7 +100,7 @@ eio_event_loop();
</programlisting>
&example.outputs.similar;
<screen>
- <![CDATA[
+<![CDATA[
resource(4) of type (EIO Request Descriptor)
string(14) "my_custom_data"
string(14) "my_custom_data"
@@ -114,9 +108,8 @@ int(2)
string(14) "my custom data"
int(1001)
]]>
- </screen>
- </example>
- </para>
+</screen>
+</example>
<para>
<example>
@@ -188,10 +181,9 @@ bool(true)
</example>
</para>
-<para>
- <example>
- <title>Using eio with libevent extension</title>
- <programlisting role="php"><![CDATA[
+<example>
+ <title>Using eio with libevent extension</title>
+ <programlisting role="php"><![CDATA[
<?php
function my_eio_poll($fd, $events, $arg) {
/* Some libevent regulation might go here .. */
@@ -219,7 +211,7 @@ eio_mkdir("/tmp/abc-eio-temp", 0750, EIO_PRI_DEFAULT, "my_nop_cb", "nop data");
// set event flags
event_set($event, $fd, EV_READ /*| EV_PERSIST*/, "my_eio_poll", array($event, $base));
-// set event base
+// set event base
event_base_set($event, $base);
// enable event
@@ -234,21 +226,19 @@ event_base_loop($base);
&example.outputs.similar;
<screen>
- <![CDATA[
+<![CDATA[
int(3)
int(0)
string(8) "nop data"
int(0)
string(10) "mkdir data"
]]>
- </screen>
+</screen>
</example>
-</para>
-<para>
- <example>
- <title>Using eio with event extension</title>
- <programlisting role="php"><![CDATA[
+<example>
+ <title>Using eio with event extension</title>
+ <programlisting role="php"><![CDATA[
<?php
$base = new EventBase();
@@ -282,16 +272,14 @@ $base->dispatch();
&example.outputs.similar;
<screen>
- <![CDATA[
+<![CDATA[
eio_nop
2 seconds elapsed
]]>
- </screen>
+</screen>
</example>
-</para>
</chapter>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/eio/functions/eio-readdir.xml b/reference/eio/functions/eio-readdir.xml
index 23c4a90c2914..a9942537fef9 100644
--- a/reference/eio/functions/eio-readdir.xml
+++ b/reference/eio/functions/eio-readdir.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="function.eio-readdir" 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.eio-readdir">
<refnamediv>
<refname>eio_readdir</refname>
<refpurpose>Reads through a whole directory</refpurpose>
@@ -15,8 +14,7 @@
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
<methodparam><type>int</type><parameter>pri</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
- <methodparam
- choice="opt"><type>string</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
+ <methodparam choice="opt"><type>string</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
Reads through a whole directory(via the <literal>opendir</literal>, <literal>readdir</literal> and
@@ -72,78 +70,76 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- <function>eio_readdir</function> returns request resource on success,&return.falseforfailure;.
+ <function>eio_readdir</function> returns request resource on success,&return.falseforfailure;.
Sets <parameter>result</parameter> argument of
<parameter>callback</parameter> function according to
<parameter>flags</parameter>:
</para>
- <para>
- <variablelist>
+ <variablelist>
- <!--{{{ EIO_READDIR_* -->
- <varlistentry>
- <term>
- <constant>EIO_READDIR_DENTS</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
- <function>eio_readdir</function> flag. If specified, the result argument of the callback
- becomes an array with the following keys:
- <literal>'names'</literal> - array of directory names
- <literal>'dents'</literal> - array of <literal>struct
- eio_dirent</literal>-like arrays having the following keys each:
- <literal>'name'</literal> - the directory name;
- <literal>'type'</literal> - one of <emphasis>EIO_DT_*</emphasis>
- constants;
- <literal>'inode'</literal> - the inode number, if available, otherwise
- unspecified;
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>EIO_READDIR_DIRS_FIRST</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
- When this flag is specified, the names will be returned in an order
- where likely directories come first, in optimal stat order.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>EIO_READDIR_STAT_ORDER</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
- When this flag is specified, then the names will be returned in an order
- suitable for <literal>stat</literal>'ing each one. When planning to
- <function>stat</function> all files in the given directory, the
- returned order will likely be
- fastest.
- </simpara>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <constant>EIO_READDIR_FOUND_UNKNOWN</constant>
- (<type>int</type>)
- </term>
- <listitem>
- <simpara>
+ <!--{{{ EIO_READDIR_* -->
+ <varlistentry>
+ <term>
+ <constant>EIO_READDIR_DENTS</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ <function>eio_readdir</function> flag. If specified, the result argument of the callback
+ becomes an array with the following keys:
+ <literal>'names'</literal> - array of directory names
+ <literal>'dents'</literal> - array of <literal>struct
+ eio_dirent</literal>-like arrays having the following keys each:
+ <literal>'name'</literal> - the directory name;
+ <literal>'type'</literal> - one of <emphasis>EIO_DT_*</emphasis>
+ constants;
+ <literal>'inode'</literal> - the inode number, if available, otherwise
+ unspecified;
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <constant>EIO_READDIR_DIRS_FIRST</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ When this flag is specified, the names will be returned in an order
+ where likely directories come first, in optimal stat order.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <constant>EIO_READDIR_STAT_ORDER</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
+ When this flag is specified, then the names will be returned in an order
+ suitable for <literal>stat</literal>'ing each one. When planning to
+ <function>stat</function> all files in the given directory, the
+ returned order will likely be
+ fastest.
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <constant>EIO_READDIR_FOUND_UNKNOWN</constant>
+ (<type>int</type>)
+ </term>
+ <listitem>
+ <simpara>
- </simpara>
- </listitem>
- </varlistentry>
+ </simpara>
+ </listitem>
+ </varlistentry>
<!--}}}-->
- </variablelist>
- </para>
+ </variablelist>
<para>Node types:
<variablelist>
@@ -324,9 +320,9 @@
</simpara>
</listitem>
</varlistentry>
-
+
<!--}}}-->
-
+
</variablelist>
</para>
</refsect1>
@@ -463,7 +459,6 @@ result: array(2) {
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml