[DOC-CVS] [doc-en] master: expect: fix XML by converting para to simpara tags via script (#5142)
[email protected] (Gina Peter Banyard via GitHub)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Gina Peter Banyard (Girgias)
Committer: GitHub (web-flow)
Pusher: Girgias
Date: 2026-01-18T22:08:01Z
Commit: https://github.com/php/doc-en/commit/ca6054f609661c9d0513aad1e7db1d8fdf33bed8
Raw diff: https://github.com/php/doc-en/commit/ca6054f609661c9d0513aad1e7db1d8fdf33bed8.diff
expect: fix XML by converting para to simpara tags via script (#5142)
Changed paths:
M reference/expect/book.xml
M reference/expect/configure.xml
M reference/expect/examples.xml
M reference/expect/functions/expect-expectl.xml
M reference/expect/functions/expect-popen.xml
M reference/expect/ini.xml
M reference/expect/setup.xml
Diff:
diff --git a/reference/expect/book.xml b/reference/expect/book.xml
index 89fc0c674488..967ec0540e03 100644
--- a/reference/expect/book.xml
+++ b/reference/expect/book.xml
@@ -1,29 +1,27 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<book xml:id="book.expect" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.expect">
<?phpdoc extension-membership="pecl" ?>
<title>Expect</title>
-
+
<!-- {{{ preface -->
<preface xml:id="intro.expect">
&reftitle.intro;
- <para>
+ <simpara>
This extension allows to interact with processes through PTY. You may
consider using the <link linkend="wrappers.expect"><literal>expect://</literal>
wrapper</link> with the <link linkend="ref.filesystem">filesystem
functions</link> which provide a simpler and more intuitive interface.
- </para>
+ </simpara>
</preface>
<!-- }}} -->
-
+
&reference.expect.setup;
&reference.expect.constants;
&reference.expect.examples;
&reference.expect.reference;
</book>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -44,4 +42,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-
diff --git a/reference/expect/configure.xml b/reference/expect/configure.xml
index a7975c0ba180..013a9b2b8564 100644
--- a/reference/expect/configure.xml
+++ b/reference/expect/configure.xml
@@ -1,24 +1,23 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<section xml:id="expect.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="expect.installation">
&reftitle.install;
- <para>
+ <simpara>
&pecl.moved;
&pecl.info;
<link xlink:href="&url.pecl.package;expect">&url.pecl.package;expect</link>.
- </para>
- <para>
+ </simpara>
+ <simpara>
In order to use these functions you must compile PHP with expect support
- by using the <option role="configure">--with-expect[=DIR]</option>
+ by using the <option role="configure">--with-expect[=DIR]</option>
configure option.
- </para>
- <para>
+ </simpara>
+ <simpara>
Windows users will enable <filename>php_expect.dll</filename> inside
of &php.ini; in order to use these functions.
&pecl.windows.download;
- </para>
+ </simpara>
</section>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -39,4 +38,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-
diff --git a/reference/expect/examples.xml b/reference/expect/examples.xml
index 2f02cbaedd79..816647900eb8 100644
--- a/reference/expect/examples.xml
+++ b/reference/expect/examples.xml
@@ -1,16 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<chapter xml:id="expect.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="expect.examples">
&reftitle.examples;
<section xml:id="expect.examples-usage">
<title>Expect Usage Examples</title>
<example>
<title>Expect Usage Example</title>
- <para>
+ <simpara>
This example connects to the remote host via SSH, and prints the remote
uptime.
- </para>
+ </simpara>
<programlisting role="php">
<![CDATA[
<?php
@@ -26,7 +25,7 @@ switch (expect_expectl ($stream, $cases)) {
case PASSWORD:
fwrite ($stream, "password\n");
break;
-
+
default:
die ("Error was occurred while connecting to the remote host!\n");
}
@@ -40,10 +39,10 @@ fclose ($stream);
</programlisting>
</example>
- <para>
+ <simpara>
The following example connects to the remote host, determines whether
installed OS is for 32 or 64 bit, then runs update for specific package.
- </para>
+ </simpara>
<example>
<title>Another Expect Usage Example</title>
<programlisting role="php">
@@ -115,7 +114,6 @@ fclose ($stream);
</example>
</section>
</chapter>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -136,4 +134,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-
diff --git a/reference/expect/functions/expect-expectl.xml b/reference/expect/functions/expect-expectl.xml
index 2e214e4df749..62107912a9ce 100644
--- a/reference/expect/functions/expect-expectl.xml
+++ b/reference/expect/functions/expect-expectl.xml
@@ -15,17 +15,17 @@
<methodparam><type>array</type><parameter>cases</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">match</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Waits until the output from a process matches one of the patterns,
a specified time period has passed, or an <acronym>EOF</acronym> is seen.
- </para>
- <para>
+ </simpara>
+ <simpara>
If <parameter>match</parameter> is provided, then it is filled with the result of search.
The matched string can be found in <parameter>match[0]</parameter>.
The match substrings (according to the parentheses) in the original pattern can be found
in <parameter>match[1]</parameter>, <parameter>match[2]</parameter>, and so
on, up to <parameter>match[9]</parameter> (the limitation of libexpect).
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -33,10 +33,10 @@
<varlistentry>
<term><parameter>expect</parameter></term>
<listitem>
- <para>
+ <simpara>
An Expect stream, previously opened with
<function>expect_popen</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -95,16 +95,16 @@
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns value associated with the pattern that was matched.
- </para>
- <para>
+ </simpara>
+ <simpara>
On failure this function returns:
<link linkend="constant.exp-eof"><constant>EXP_EOF</constant></link>,
<link linkend="constant.exp-timeout"><constant>EXP_TIMEOUT</constant></link>
or
<link linkend="constant.exp-fullbuffer"><constant>EXP_FULLBUFFER</constant></link>
- </para>
+ </simpara>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
diff --git a/reference/expect/functions/expect-popen.xml b/reference/expect/functions/expect-popen.xml
index 404ed62ac383..ae96a02286f6 100644
--- a/reference/expect/functions/expect-popen.xml
+++ b/reference/expect/functions/expect-popen.xml
@@ -12,9 +12,9 @@
<type>resource</type><methodname>expect_popen</methodname>
<methodparam><type>string</type><parameter>command</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Execute command via Bourne shell, and open the PTY stream to the process.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -22,22 +22,22 @@
<varlistentry>
<term><parameter>command</parameter></term>
<listitem>
- <para>
+ <simpara>
Command to execute.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns an open PTY stream to the processes <literal>stdio</literal>,
<literal>stdout</literal>, and <literal>stderr</literal>.
- </para>
- <para>
+ </simpara>
+ <simpara>
On failure this function returns &false;.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
diff --git a/reference/expect/ini.xml b/reference/expect/ini.xml
index 09cf101ca388..0a39e9df559e 100644
--- a/reference/expect/ini.xml
+++ b/reference/expect/ini.xml
@@ -57,18 +57,18 @@
<type>int</type>
</term>
<listitem>
- <para>
+ <simpara>
The timeout period for waiting for the data, when using the
<function>expect_expectl</function> function.
- </para>
- <para>
+ </simpara>
+ <simpara>
A value of "-1" disables a timeout from occurring.
- </para>
+ </simpara>
<note>
- <para>
+ <simpara>
A value of "0" causes the <function>expect_expectl</function>
function to return immediately.
- </para>
+ </simpara>
</note>
</listitem>
</varlistentry>
@@ -79,11 +79,11 @@
<type>bool</type>
</term>
<listitem>
- <para>
+ <simpara>
Whether expect should send any output from the spawned process to stdout.
Since interactive programs typically echo their input, this usually suffices
to show both sides of the conversation.
- </para>
+ </simpara>
</listitem>
</varlistentry>
@@ -93,15 +93,15 @@
<type>string</type>
</term>
<listitem>
- <para>
+ <simpara>
Name of the file, where the output from the spawned process will be
written. If this file doesn't exist, it will be created.
- </para>
+ </simpara>
<note>
- <para>
+ <simpara>
If this configuration is not empty, the output is written regardless of
the value of <link linkend="ini.expect.loguser">expect.loguser</link>.
- </para>
+ </simpara>
</note>
</listitem>
</varlistentry>
@@ -112,10 +112,10 @@
<type>int</type>
</term>
<listitem>
- <para>
+ <simpara>
Changes default size (2000 bytes) of the buffer used to match asterisks
in patterns.
- </para>
+ </simpara>
</listitem>
</varlistentry>
diff --git a/reference/expect/setup.xml b/reference/expect/setup.xml
index 760527cd1d32..dc7b5b1de595 100644
--- a/reference/expect/setup.xml
+++ b/reference/expect/setup.xml
@@ -1,17 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<chapter xml:id="expect.setup" 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="expect.setup">
&reftitle.setup;
<!-- {{{ Requirements -->
<section xml:id="expect.requirements">
&reftitle.required;
- <para>
- This module uses the functions of the <link
- xlink:href="&url.expect;">expect</link> library.
+ <simpara>
+ This module uses the functions of the <link xlink:href="&url.expect;">expect</link> library.
You need libexpect version >= 5.43.0.
- </para>
+ </simpara>
</section>
<!-- }}} -->
@@ -26,15 +24,14 @@
<!-- {{{ Resources -->
<section xml:id="expect.resources">
&reftitle.resources;
- <para>
+ <simpara>
<function>expect_popen</function> returns an open PTY stream used by
<function>expect_expectl</function>.
- </para>
+ </simpara>
</section>
<!-- }}} -->
</chapter>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -55,4 +52,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-