[DOC-CVS] [doc-en] master: shmop: 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:33:28Z
Commit: https://github.com/php/doc-en/commit/6ce09e40979a5cd7ee87a4799cbaf1d8d17a3dc1
Raw diff: https://github.com/php/doc-en/commit/6ce09e40979a5cd7ee87a4799cbaf1d8d17a3dc1.diff
shmop: fix XML to remove useless wrapping para tags via script
Changed paths:
M reference/shmop/examples.xml
M reference/shmop/functions/shmop-close.xml
M reference/shmop/functions/shmop-delete.xml
M reference/shmop/functions/shmop-open.xml
M reference/shmop/functions/shmop-read.xml
M reference/shmop/functions/shmop-size.xml
M reference/shmop/functions/shmop-write.xml
Diff:
diff --git a/reference/shmop/examples.xml b/reference/shmop/examples.xml
index 9b5d487d538e..16ea41ea40bb 100644
--- a/reference/shmop/examples.xml
+++ b/reference/shmop/examples.xml
@@ -1,17 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<chapter xml:id="shmop.examples" xmlns="http://docbook.org/ns/docbook">
+<chapter xmlns="http://docbook.org/ns/docbook" xml:id="shmop.examples">
&reftitle.examples;
<section xml:id="shmop.examples-basic">
<title>Basic usage</title>
- <para>
- <example>
- <title>Shared Memory Operations Overview</title>
- <programlisting role="php">
+ <example>
+ <title>Shared Memory Operations Overview</title>
+ <programlisting role="php">
<![CDATA[
<?php
-
+
// Create 100 byte shared memory block with system id of 0xff3
$shm_id = shmop_open(0xff3, "c", 0644, 100);
if (!$shm_id) {
@@ -40,15 +38,13 @@ if (!shmop_delete($shm_id)) {
echo "Couldn't mark shared memory block for deletion.";
}
shmop_close($shm_id);
-
+
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</section>
</chapter>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -69,4 +65,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/shmop/functions/shmop-close.xml b/reference/shmop/functions/shmop-close.xml
index 520b48c44a26..cfd63b22da81 100644
--- a/reference/shmop/functions/shmop-close.xml
+++ b/reference/shmop/functions/shmop-close.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.shmop-close" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shmop-close">
<refnamediv>
<refname>shmop_close</refname>
<refpurpose>Close shared memory block</refpurpose>
@@ -24,19 +24,17 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>shmop</parameter></term>
- <listitem>
- <para>
- The shared memory block resource created by
- <function>shmop_open</function>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>shmop</parameter></term>
+ <listitem>
+ <para>
+ The shared memory block resource created by
+ <function>shmop_open</function>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -76,29 +74,25 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Closing shared memory block</title>
- <programlisting role="php">
+ <example>
+ <title>Closing shared memory block</title>
+ <programlisting role="php">
<![CDATA[
<?php
shmop_close($shm_id);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
<para>
This example will close shared memory block identified by <literal>$shm_id</literal>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>shmop_open</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>shmop_open</function></member>
+ </simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
diff --git a/reference/shmop/functions/shmop-delete.xml b/reference/shmop/functions/shmop-delete.xml
index 2160725ac97e..30aaef163c43 100644
--- a/reference/shmop/functions/shmop-delete.xml
+++ b/reference/shmop/functions/shmop-delete.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.shmop-delete" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shmop-delete">
<refnamediv>
<refname>shmop_delete</refname>
<refpurpose>Delete shared memory block</refpurpose>
@@ -17,19 +17,17 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>shmop</parameter></term>
- <listitem>
- <para>
- The shared memory block resource created by
- <function>shmop_open</function>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>shmop</parameter></term>
+ <listitem>
+ <para>
+ The shared memory block resource created by
+ <function>shmop_open</function>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -63,18 +61,16 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Deleting shared memory block</title>
- <programlisting role="php">
+ <example>
+ <title>Deleting shared memory block</title>
+ <programlisting role="php">
<![CDATA[
<?php
shmop_delete($shm_id);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
<para>
This example will delete shared memory block identified by
<literal>$shm_id</literal>.
diff --git a/reference/shmop/functions/shmop-open.xml b/reference/shmop/functions/shmop-open.xml
index d2765a2b214d..32db2deb001e 100644
--- a/reference/shmop/functions/shmop-open.xml
+++ b/reference/shmop/functions/shmop-open.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.shmop-open" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shmop-open">
<refnamediv>
<refname>shmop_open</refname>
<refpurpose>Create or open shared memory block</refpurpose>
@@ -150,19 +150,17 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Create a new shared memory block</title>
- <programlisting role="php">
+ <example>
+ <title>Create a new shared memory block</title>
+ <programlisting role="php">
<![CDATA[
<?php
$shm_key = ftok(__FILE__, 't');
$shm_id = shmop_open($shm_key, "c", 0644, 100);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
<para>
This example opened a shared memory block with a system id returned by
<function>ftok</function>.
@@ -170,12 +168,10 @@ $shm_id = shmop_open($shm_key, "c", 0644, 100);
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>shmop_close</function></member>
- <member><function>shmop_delete</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>shmop_close</function></member>
+ <member><function>shmop_delete</function></member>
+ </simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
diff --git a/reference/shmop/functions/shmop-read.xml b/reference/shmop/functions/shmop-read.xml
index e5dee4fc7f50..ce10912b0d2a 100644
--- a/reference/shmop/functions/shmop-read.xml
+++ b/reference/shmop/functions/shmop-read.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.shmop-read" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shmop-read">
<refnamediv>
<refname>shmop_read</refname>
<refpurpose>Read data from shared memory block</refpurpose>
@@ -19,39 +19,37 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>shmop</parameter></term>
- <listitem>
- <para>
- The shared memory block identifier created by
- <function>shmop_open</function>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>offset</parameter></term>
- <listitem>
- <para>
- Offset from which to start reading; must be greater than or equal to zero
- and less than or equal to the actual size of the shared memory segment.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>size</parameter></term>
- <listitem>
- <para>
- The number of bytes to read; must be greater than or equal to zero,
- and the sum of <parameter>offset</parameter> and <parameter>size</parameter>
- must be less than or equal to the actual size of the shared memory segment.
- <literal>0</literal> reads <code>shmop_size($shmid) - $start</code> bytes.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>shmop</parameter></term>
+ <listitem>
+ <para>
+ The shared memory block identifier created by
+ <function>shmop_open</function>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>offset</parameter></term>
+ <listitem>
+ <para>
+ Offset from which to start reading; must be greater than or equal to zero
+ and less than or equal to the actual size of the shared memory segment.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>size</parameter></term>
+ <listitem>
+ <para>
+ The number of bytes to read; must be greater than or equal to zero,
+ and the sum of <parameter>offset</parameter> and <parameter>size</parameter>
+ must be less than or equal to the actual size of the shared memory segment.
+ <literal>0</literal> reads <code>shmop_size($shmid) - $start</code> bytes.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -101,18 +99,16 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Reading shared memory block</title>
- <programlisting role="php">
+ <example>
+ <title>Reading shared memory block</title>
+ <programlisting role="php">
<![CDATA[
<?php
$shm_data = shmop_read($shm_id, 0, 50);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
<para>
This example will read 50 bytes from shared memory block and place the data
inside <literal>$shm_data</literal>.
@@ -120,11 +116,9 @@ $shm_data = shmop_read($shm_id, 0, 50);
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>shmop_write</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>shmop_write</function></member>
+ </simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
diff --git a/reference/shmop/functions/shmop-size.xml b/reference/shmop/functions/shmop-size.xml
index 729aff276060..c35385b2ce42 100644
--- a/reference/shmop/functions/shmop-size.xml
+++ b/reference/shmop/functions/shmop-size.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.shmop-size" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shmop-size">
<refnamediv>
<refname>shmop_size</refname>
<refpurpose>Get size of shared memory block</refpurpose>
@@ -18,19 +18,17 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>shmop</parameter></term>
- <listitem>
- <para>
- The shared memory block identifier created by
- <function>shmop_open</function>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>shmop</parameter></term>
+ <listitem>
+ <para>
+ The shared memory block identifier created by
+ <function>shmop_open</function>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -65,18 +63,16 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Getting the size of the shared memory block</title>
- <programlisting role="php">
+ <example>
+ <title>Getting the size of the shared memory block</title>
+ <programlisting role="php">
<![CDATA[
<?php
$shm_size = shmop_size($shm_id);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
<para>
This example will put the size of shared memory block identified by
<literal>$shm_id</literal> into <literal>$shm_size</literal>.
diff --git a/reference/shmop/functions/shmop-write.xml b/reference/shmop/functions/shmop-write.xml
index c7701bcb744d..6f8df10b4457 100644
--- a/reference/shmop/functions/shmop-write.xml
+++ b/reference/shmop/functions/shmop-write.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.shmop-write" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shmop-write">
<refnamediv>
<refname>shmop_write</refname>
<refpurpose>Write data into shared memory block</refpurpose>
@@ -19,37 +19,35 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>shmop</parameter></term>
- <listitem>
- <para>
- The shared memory block identifier created by
- <function>shmop_open</function>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>data</parameter></term>
- <listitem>
- <para>
- A string to write into shared memory block
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>offset</parameter></term>
- <listitem>
- <para>
- Specifies where to start writing data inside the shared memory
- segment. The offset must be greater than or equal to zero
- and less than or equal to the actual size of the shared memory segment.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>shmop</parameter></term>
+ <listitem>
+ <para>
+ The shared memory block identifier created by
+ <function>shmop_open</function>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>data</parameter></term>
+ <listitem>
+ <para>
+ A string to write into shared memory block
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>offset</parameter></term>
+ <listitem>
+ <para>
+ Specifies where to start writing data inside the shared memory
+ segment. The offset must be greater than or equal to zero
+ and less than or equal to the actual size of the shared memory segment.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -97,18 +95,16 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Writing to shared memory block</title>
- <programlisting role="php">
+ <example>
+ <title>Writing to shared memory block</title>
+ <programlisting role="php">
<![CDATA[
<?php
$shm_bytes_written = shmop_write($shm_id, $my_string, 0);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
<para>
This example will write data inside <literal>$my_string</literal> into
shared memory block, <literal>$shm_bytes_written</literal> will contain
@@ -117,11 +113,9 @@ $shm_bytes_written = shmop_write($shm_id, $my_string, 0);
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>shmop_read</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>shmop_read</function></member>
+ </simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file