[DOC-CVS] [doc-en] master: inotify: fix XML to remove useless wrapping para tags via automatic script
[email protected] (Gina Peter Banyard)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Gina Peter Banyard (Girgias)
Date: 2026-01-16T08:53:04Z
Commit: https://github.com/php/doc-en/commit/1535c9db42a02b4c6ed720735ee13b5af5c2bbdc
Raw diff: https://github.com/php/doc-en/commit/1535c9db42a02b4c6ed720735ee13b5af5c2bbdc.diff
inotify: fix XML to remove useless wrapping para tags via automatic script
Changed paths:
M reference/inotify/functions/inotify-add-watch.xml
M reference/inotify/functions/inotify-init.xml
M reference/inotify/functions/inotify-queue-len.xml
M reference/inotify/functions/inotify-read.xml
M reference/inotify/functions/inotify-rm-watch.xml
Diff:
diff --git a/reference/inotify/functions/inotify-add-watch.xml b/reference/inotify/functions/inotify-add-watch.xml
index b85afe7b8560..0553cc4452b5 100644
--- a/reference/inotify/functions/inotify-add-watch.xml
+++ b/reference/inotify/functions/inotify-add-watch.xml
@@ -1,12 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="function.inotify-add-watch" 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.inotify-add-watch">
<refnamediv>
<refname>inotify_add_watch</refname>
<refpurpose>Add a watch to an initialized inotify instance</refpurpose>
</refnamediv>
-
+
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
<methodsynopsis>
@@ -26,40 +25,37 @@
adds (OR) events to the existing watch.
</para>
</refsect1><!-- }}} -->
-
+
<refsect1 role="parameters"><!-- {{{ -->
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>inotify_instance</parameter></term>
- <listitem>
- <para>
- &inotify.instance.description;
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>pathname</parameter></term>
- <listitem>
- <para>
- File or directory to watch
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>mask</parameter></term>
- <listitem>
- <para>
- Events to watch for. See <link
- linkend="inotify.constants">&ReservedConstants;</link>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>inotify_instance</parameter></term>
+ <listitem>
+ <para>
+ &inotify.instance.description;
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>pathname</parameter></term>
+ <listitem>
+ <para>
+ File or directory to watch
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mask</parameter></term>
+ <listitem>
+ <para>
+ Events to watch for. See <link linkend="inotify.constants">&ReservedConstants;</link>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1><!-- }}} -->
-
+
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
<para>
@@ -67,18 +63,15 @@
&return.falseforfailure;.
</para>
</refsect1><!-- }}} -->
-
+
<refsect1 role="seealso"><!-- {{{ -->
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>inotify_init</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>inotify_init</function></member>
+ </simplelist>
</refsect1><!-- }}} -->
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -99,4 +92,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/inotify/functions/inotify-init.xml b/reference/inotify/functions/inotify-init.xml
index cdd763199d13..9a4d424f79e0 100644
--- a/reference/inotify/functions/inotify-init.xml
+++ b/reference/inotify/functions/inotify-init.xml
@@ -1,17 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="function.inotify-init" 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.inotify-init">
<refnamediv>
<refname>inotify_init</refname>
<refpurpose>Initialize an inotify instance</refpurpose>
</refnamediv>
-
+
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
<methodsynopsis>
<type class="union"><type>resource</type><type>false</type></type><methodname>inotify_init</methodname>
- <void />
+ <void/>
</methodsynopsis>
<para>
Initialize an inotify instance for use with
@@ -23,14 +22,14 @@
&reftitle.parameters;
&no.function.parameters;
</refsect1>
-
+
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
<para>
A stream resource or &false; on error.
</para>
</refsect1><!-- }}} -->
-
+
<refsect1 role="examples"><!-- {{{ -->
&reftitle.examples;
<para>
@@ -84,7 +83,7 @@ array(
array(
'wd' => 1, // Equals $watch_descriptor
'mask' => 4, // IN_ATTRIB bit is set
- 'cookie' => 0, // unique id to connect related events (e.g.
+ 'cookie' => 0, // unique id to connect related events (e.g.
// IN_MOVE_FROM and IN_MOVE_TO events)
'name' => '', // the name of a file (e.g. if we monitored changes
// in a directory)
@@ -95,22 +94,19 @@ array(
</example><!-- }}} -->
</para>
</refsect1><!-- }}} -->
-
+
<refsect1 role="seealso"><!-- {{{ -->
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>inotify_add_watch</function></member>
- <member><function>inotify_rm_watch</function></member>
- <member><function>inotify_queue_len</function></member>
- <member><function>inotify_read</function></member>
- <member><function>fclose</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>inotify_add_watch</function></member>
+ <member><function>inotify_rm_watch</function></member>
+ <member><function>inotify_queue_len</function></member>
+ <member><function>inotify_read</function></member>
+ <member><function>fclose</function></member>
+ </simplelist>
</refsect1><!-- }}} -->
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -131,4 +127,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/inotify/functions/inotify-queue-len.xml b/reference/inotify/functions/inotify-queue-len.xml
index 00b4ab650543..0c257694e70e 100644
--- a/reference/inotify/functions/inotify-queue-len.xml
+++ b/reference/inotify/functions/inotify-queue-len.xml
@@ -1,12 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="function.inotify-queue-len" 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.inotify-queue-len">
<refnamediv>
<refname>inotify_queue_len</refname>
<refpurpose>Return a number upper than zero if there are pending events</refpurpose>
</refnamediv>
-
+
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
<methodsynopsis>
@@ -15,47 +14,42 @@
</methodsynopsis>
<para>
This function allows to know if <function>inotify_read</function> will block or not.
- If a number upper than zero is returned, there are pending events and
- <function>inotify_read</function> will not block.
+ If a number upper than zero is returned, there are pending events and
+ <function>inotify_read</function> will not block.
</para>
</refsect1><!-- }}} -->
-
+
<refsect1 role="parameters"><!-- {{{ -->
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>inotify_instance</parameter></term>
- <listitem>
- <para>
- &inotify.instance.description;
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>inotify_instance</parameter></term>
+ <listitem>
+ <para>
+ &inotify.instance.description;
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1><!-- }}} -->
-
+
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
<para>
- Returns a number upper than zero if there are pending events.
+ Returns a number upper than zero if there are pending events.
</para>
</refsect1><!-- }}} -->
-
+
<refsect1 role="seealso"><!-- {{{ -->
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>inotify_init</function></member>
- <member><function>stream_select</function></member>
- <member><function>stream_set_blocking</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>inotify_init</function></member>
+ <member><function>stream_select</function></member>
+ <member><function>stream_set_blocking</function></member>
+ </simplelist>
</refsect1><!-- }}} -->
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -76,4 +70,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/inotify/functions/inotify-read.xml b/reference/inotify/functions/inotify-read.xml
index ae91494b3641..05e9bc508114 100644
--- a/reference/inotify/functions/inotify-read.xml
+++ b/reference/inotify/functions/inotify-read.xml
@@ -1,12 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="function.inotify-read" 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.inotify-read">
<refnamediv>
<refname>inotify_read</refname>
<refpurpose>Read events from an inotify instance</refpurpose>
</refnamediv>
-
+
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
<methodsynopsis>
@@ -17,23 +16,21 @@
Read inotify events from an inotify instance.
</para>
</refsect1><!-- }}} -->
-
+
<refsect1 role="parameters"><!-- {{{ -->
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>inotify_instance</parameter></term>
- <listitem>
- <para>
- &inotify.instance.description;
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>inotify_instance</parameter></term>
+ <listitem>
+ <para>
+ &inotify.instance.description;
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1><!-- }}} -->
-
+
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
<para>
@@ -50,21 +47,18 @@
</simplelist>
</para>
</refsect1><!-- }}} -->
-
+
<refsect1 role="seealso"><!-- {{{ -->
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>inotify_init</function></member>
- <member><function>stream_select</function></member>
- <member><function>stream_set_blocking</function></member>
- <member><function>inotify_queue_len</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>inotify_init</function></member>
+ <member><function>stream_select</function></member>
+ <member><function>stream_set_blocking</function></member>
+ <member><function>inotify_queue_len</function></member>
+ </simplelist>
</refsect1><!-- }}} -->
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -85,4 +79,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/inotify/functions/inotify-rm-watch.xml b/reference/inotify/functions/inotify-rm-watch.xml
index df28f57eea6d..a38dd4e210d8 100644
--- a/reference/inotify/functions/inotify-rm-watch.xml
+++ b/reference/inotify/functions/inotify-rm-watch.xml
@@ -1,12 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="function.inotify-rm-watch" 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.inotify-rm-watch">
<refnamediv>
<refname>inotify_rm_watch</refname>
<refpurpose>Remove an existing watch from an inotify instance</refpurpose>
</refnamediv>
-
+
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
<methodsynopsis>
@@ -20,49 +19,44 @@
<parameter>inotify_instance</parameter>.
</para>
</refsect1><!-- }}} -->
-
+
<refsect1 role="parameters"><!-- {{{ -->
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>inotify_instance</parameter></term>
- <listitem>
- <para>
- &inotify.instance.description;
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>watch_descriptor</parameter></term>
- <listitem>
- <para>
- Watch to remove from the instance
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>inotify_instance</parameter></term>
+ <listitem>
+ <para>
+ &inotify.instance.description;
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>watch_descriptor</parameter></term>
+ <listitem>
+ <para>
+ Watch to remove from the instance
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1><!-- }}} -->
-
+
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1><!-- }}} -->
-
+
<refsect1 role="seealso"><!-- {{{ -->
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>inotify_init</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>inotify_init</function></member>
+ </simplelist>
</refsect1><!-- }}} -->
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -83,4 +77,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-