[DOC-CVS] [doc-en] master: readline: 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-26T15:30:36Z
Commit: https://github.com/php/doc-en/commit/3c4eb41f4747d9f6e8ae17574177d92a2d1d5810
Raw diff: https://github.com/php/doc-en/commit/3c4eb41f4747d9f6e8ae17574177d92a2d1d5810.diff
readline: fix XML to remove useless wrapping para tags via script
Changed paths:
M reference/readline/functions/readline-add-history.xml
M reference/readline/functions/readline-callback-handler-install.xml
M reference/readline/functions/readline-callback-handler-remove.xml
M reference/readline/functions/readline-callback-read-char.xml
M reference/readline/functions/readline-completion-function.xml
M reference/readline/functions/readline-info.xml
M reference/readline/functions/readline-read-history.xml
M reference/readline/functions/readline-write-history.xml
M reference/readline/functions/readline.xml
M reference/readline/ini.xml
Diff:
diff --git a/reference/readline/functions/readline-add-history.xml b/reference/readline/functions/readline-add-history.xml
index 1bf8e47500cd..a9690cfd0738 100644
--- a/reference/readline/functions/readline-add-history.xml
+++ b/reference/readline/functions/readline-add-history.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.readline-add-history" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-add-history">
<refnamediv>
<refname>readline_add_history</refname>
<refpurpose>Adds a line to the history</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -19,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>prompt</parameter></term>
- <listitem>
- <para>
- The line to be added in the history.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>prompt</parameter></term>
+ <listitem>
+ <para>
+ The line to be added in the history.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
diff --git a/reference/readline/functions/readline-callback-handler-install.xml b/reference/readline/functions/readline-callback-handler-install.xml
index d1ae71772a8e..2cabc5b27c3d 100644
--- a/reference/readline/functions/readline-callback-handler-install.xml
+++ b/reference/readline/functions/readline-callback-handler-install.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.readline-callback-handler-install" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-callback-handler-install">
<refnamediv>
<refname>readline_callback_handler_install</refname>
<refpurpose>Initializes the readline callback interface and terminal, prints the prompt and returns immediately</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -15,7 +15,7 @@
</methodsynopsis>
<para>
Sets up a readline callback interface then prints
- <parameter>prompt</parameter> and immediately returns.
+ <parameter>prompt</parameter> and immediately returns.
Calling this function twice without removing the previous
callback interface will automatically and conveniently overwrite the old
interface.
@@ -29,27 +29,25 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>prompt</parameter></term>
- <listitem>
- <para>
- The prompt message.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>callback</parameter></term>
- <listitem>
- <para>
- The <parameter>callback</parameter> function takes one parameter; the
- user input returned.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>prompt</parameter></term>
+ <listitem>
+ <para>
+ The prompt message.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>callback</parameter></term>
+ <listitem>
+ <para>
+ The <parameter>callback</parameter> function takes one parameter; the
+ user input returned.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -58,13 +56,12 @@
&return.true.always;
</para>
</refsect1>
-
+
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Readline Callback Interface Example</title>
- <programlisting role="php">
+ <example>
+ <title>Readline Callback Interface Example</title>
+ <programlisting role="php">
<![CDATA[
<?php
function rl_callback($ret)
@@ -100,20 +97,17 @@ while ($prompting) {
echo "Prompting disabled. All done.\n";
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>readline_callback_handler_remove</function></member>
- <member><function>readline_callback_read_char</function></member>
- <member><function>stream_select</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>readline_callback_handler_remove</function></member>
+ <member><function>readline_callback_read_char</function></member>
+ <member><function>stream_select</function></member>
+ </simplelist>
</refsect1>
</refentry>
diff --git a/reference/readline/functions/readline-callback-handler-remove.xml b/reference/readline/functions/readline-callback-handler-remove.xml
index c7c328ba758a..064ad3c2637d 100644
--- a/reference/readline/functions/readline-callback-handler-remove.xml
+++ b/reference/readline/functions/readline-callback-handler-remove.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.readline-callback-handler-remove" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-callback-handler-remove">
<refnamediv>
<refname>readline_callback_handler_remove</refname>
<refpurpose>Removes a previously installed callback handler and restores terminal settings</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -22,7 +22,7 @@
&reftitle.parameters;
&no.function.parameters;
</refsect1>
-
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@@ -30,7 +30,7 @@
&false; if one could not be found.
</para>
</refsect1>
-
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -41,16 +41,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>readline_callback_handler_install</function></member>
- <member><function>readline_callback_read_char</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>readline_callback_handler_install</function></member>
+ <member><function>readline_callback_read_char</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/readline/functions/readline-callback-read-char.xml b/reference/readline/functions/readline-callback-read-char.xml
index bec5b46d24b3..226adedf20e7 100644
--- a/reference/readline/functions/readline-callback-read-char.xml
+++ b/reference/readline/functions/readline-callback-read-char.xml
@@ -1,16 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.readline-callback-read-char" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-callback-read-char">
<refnamediv>
<refname>readline_callback_read_char</refname>
<refpurpose>Reads a character and informs the readline callback interface when a line is received</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>readline_callback_read_char</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>
Reads a character of user input. When a line is received, this function
@@ -31,7 +31,7 @@
&return.void;
</para>
</refsect1>
-
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -42,16 +42,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>readline_callback_handler_install</function></member>
- <member><function>readline_callback_handler_remove</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>readline_callback_handler_install</function></member>
+ <member><function>readline_callback_handler_remove</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/readline/functions/readline-completion-function.xml b/reference/readline/functions/readline-completion-function.xml
index 2bf06e03fc24..acc25421c35f 100644
--- a/reference/readline/functions/readline-completion-function.xml
+++ b/reference/readline/functions/readline-completion-function.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.readline-completion-function" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-completion-function">
<refnamediv>
<refname>readline_completion_function</refname>
<refpurpose>Registers a completion function</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -20,19 +20,17 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>callback</parameter></term>
- <listitem>
- <para>
- You must supply the name of an existing function which accepts a
- partial command line and returns an array of possible matches.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>callback</parameter></term>
+ <listitem>
+ <para>
+ You must supply the name of an existing function which accepts a
+ partial command line and returns an array of possible matches.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
diff --git a/reference/readline/functions/readline-info.xml b/reference/readline/functions/readline-info.xml
index 6f6c79a43032..dc185f123b50 100644
--- a/reference/readline/functions/readline-info.xml
+++ b/reference/readline/functions/readline-info.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.readline-info" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-info">
<refnamediv>
<refname>readline_info</refname>
<refpurpose>Gets/sets various internal readline variables</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -20,26 +20,24 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>var_name</parameter></term>
- <listitem>
- <para>
- A variable name.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>value</parameter></term>
- <listitem>
- <para>
- If provided, this will be the new value of the setting.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>var_name</parameter></term>
+ <listitem>
+ <para>
+ A variable name.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>value</parameter></term>
+ <listitem>
+ <para>
+ If provided, this will be the new value of the setting.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
diff --git a/reference/readline/functions/readline-read-history.xml b/reference/readline/functions/readline-read-history.xml
index 3ea1574e43ec..ae1d27a9b3b2 100644
--- a/reference/readline/functions/readline-read-history.xml
+++ b/reference/readline/functions/readline-read-history.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.readline-read-history" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-read-history">
<refnamediv>
<refname>readline_read_history</refname>
<refpurpose>Reads the history</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -19,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem>
- <para>
- Path to the filename containing the command history.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ Path to the filename containing the command history.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
diff --git a/reference/readline/functions/readline-write-history.xml b/reference/readline/functions/readline-write-history.xml
index b1421f87f9fa..c9ee0e0a92f3 100644
--- a/reference/readline/functions/readline-write-history.xml
+++ b/reference/readline/functions/readline-write-history.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.readline-write-history" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-write-history">
<refnamediv>
<refname>readline_write_history</refname>
<refpurpose>Writes the history</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -19,18 +19,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem>
- <para>
- Path to the saved file.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ Path to the saved file.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
diff --git a/reference/readline/functions/readline.xml b/reference/readline/functions/readline.xml
index a569c8c73d82..adb5e2dc8211 100644
--- a/reference/readline/functions/readline.xml
+++ b/reference/readline/functions/readline.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.readline" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline">
<refnamediv>
<refname>readline</refname>
<refpurpose>Reads a line</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -20,18 +20,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>prompt</parameter></term>
- <listitem>
- <para>
- You may specify a string with which to prompt the user.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>prompt</parameter></term>
+ <listitem>
+ <para>
+ You may specify a string with which to prompt the user.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -45,10 +43,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>readline</function> Example</title>
- <programlisting role="php">
+ <example>
+ <title><function>readline</function> Example</title>
+ <programlisting role="php">
<![CDATA[
<?php
//get 3 commands from user
@@ -64,9 +61,8 @@ print_r(readline_list_history());
print_r(readline_info());
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
diff --git a/reference/readline/ini.xml b/reference/readline/ini.xml
index 530b783cf083..02a1a17f4ccd 100644
--- a/reference/readline/ini.xml
+++ b/reference/readline/ini.xml
@@ -1,70 +1,63 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<section xml:id="readline.configuration" xmlns="http://docbook.org/ns/docbook">
+<section xmlns="http://docbook.org/ns/docbook" xml:id="readline.configuration">
&reftitle.runtime;
&extension.runtime;
- <para>
- <table>
- <title>Readline &ConfigureOptions;</title>
- <tgroup cols="4">
- <thead>
- <row>
- <entry>&Name;</entry>
- <entry>&Default;</entry>
- <entry>&Changeable;</entry>
- <entry>&Changelog;</entry>
- </row>
- </thead>
- <tbody xml:id="readline.configuration.list">
- <row>
- <entry><link linkend="ini.cli.pager">cli.pager</link></entry>
- <entry>""</entry>
- <entry><constant>INI_ALL</constant></entry>
- <entry></entry>
- </row>
- <row>
- <entry><link linkend="ini.cli.prompt">cli.prompt</link></entry>
- <entry>"\\b \\> "</entry>
- <entry><constant>INI_ALL</constant></entry>
- <entry></entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </para>
+ <table>
+ <title>Readline &ConfigureOptions;</title>
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>&Name;</entry>
+ <entry>&Default;</entry>
+ <entry>&Changeable;</entry>
+ <entry>&Changelog;</entry>
+ </row>
+ </thead>
+ <tbody xml:id="readline.configuration.list">
+ <row>
+ <entry><link linkend="ini.cli.pager">cli.pager</link></entry>
+ <entry>""</entry>
+ <entry><constant>INI_ALL</constant></entry>
+ <entry/>
+ </row>
+ <row>
+ <entry><link linkend="ini.cli.prompt">cli.prompt</link></entry>
+ <entry>"\\b \\> "</entry>
+ <entry><constant>INI_ALL</constant></entry>
+ <entry/>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
&ini.descriptions.title;
- <para>
- <variablelist>
- <varlistentry xml:id="ini.cli.pager">
- <term>
- <parameter>cli.pager</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- External tool to display output from <link
- linkend="features.commandline">command line</link>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="ini.cli.prompt">
- <term>
- <parameter>cli.prompt</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- <link linkend="features.commandline">Command line</link> prompt.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry xml:id="ini.cli.pager">
+ <term>
+ <parameter>cli.pager</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ External tool to display output from <link linkend="features.commandline">command line</link>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="ini.cli.prompt">
+ <term>
+ <parameter>cli.prompt</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ <link linkend="features.commandline">Command line</link> prompt.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml