[DOC-CVS] [doc-en] master: inotify: fix XML by converting para to simpara tags via script (#5138)
[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-18T21:46:59Z
Commit: https://github.com/php/doc-en/commit/ab6d54b20ef7436c70e0c7eb982d8f44aa2df906
Raw diff: https://github.com/php/doc-en/commit/ab6d54b20ef7436c70e0c7eb982d8f44aa2df906.diff
inotify: fix XML by converting para to simpara tags via script (#5138)
Changed paths:
M reference/inotify/book.xml
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
M reference/inotify/setup.xml
Diff:
diff --git a/reference/inotify/book.xml b/reference/inotify/book.xml
index b030f1a1da63..61d71ba98b8c 100644
--- a/reference/inotify/book.xml
+++ b/reference/inotify/book.xml
@@ -1,33 +1,31 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<book xml:id="book.inotify" 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.inotify">
<?phpdoc extension-membership="pecl" ?>
<title>Inotify</title>
-
+
<!-- {{{ preface -->
<preface xml:id="intro.inotify">
&reftitle.intro;
- <para>
+ <simpara>
The inotify extension exposes the inotify functions <function>inotify_init</function>,
<function>inotify_add_watch</function> and <function>inotify_rm_watch</function>.
- </para>
- <para>
+ </simpara>
+ <simpara>
As the C <function>inotify_init</function> function returns a file descriptor, PHP's
<function>inotify_init</function> returns a stream resource, usable with standard
- stream functions, like <function>stream_select</function>, <function>stream_set_blocking</function>
+ stream functions, like <function>stream_select</function>, <function>stream_set_blocking</function>
and <function>fclose</function>. <function>inotify_read</function> replaces the C way of reading inotify
events.
- </para>
+ </simpara>
</preface>
<!-- }}} -->
-
+
&reference.inotify.setup;
&reference.inotify.constants;
&reference.inotify.reference;
</book>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -48,4 +46,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-add-watch.xml b/reference/inotify/functions/inotify-add-watch.xml
index 0553cc4452b5..2516456c8b69 100644
--- a/reference/inotify/functions/inotify-add-watch.xml
+++ b/reference/inotify/functions/inotify-add-watch.xml
@@ -14,16 +14,16 @@
<methodparam><type>string</type><parameter>pathname</parameter></methodparam>
<methodparam><type>int</type><parameter>mask</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
<function>inotify_add_watch</function> adds a new watch or modify an
existing watch for the file or directory specified in
<parameter>pathname</parameter>.
- </para>
- <para>
+ </simpara>
+ <simpara>
Using <function>inotify_add_watch</function> on a watched object replaces
the existing watch. Using the <constant>IN_MASK_ADD</constant> constant
adds (OR) events to the existing watch.
- </para>
+ </simpara>
</refsect1><!-- }}} -->
<refsect1 role="parameters"><!-- {{{ -->
@@ -32,25 +32,25 @@
<varlistentry>
<term><parameter>inotify_instance</parameter></term>
<listitem>
- <para>
+ <simpara>
&inotify.instance.description;
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pathname</parameter></term>
<listitem>
- <para>
+ <simpara>
File or directory to watch
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mask</parameter></term>
<listitem>
- <para>
+ <simpara>
Events to watch for. See <link linkend="inotify.constants">&ReservedConstants;</link>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -58,10 +58,10 @@
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
- <para>
+ <simpara>
The return value is a unique (inotify instance wide) watch descriptor,
&return.falseforfailure;.
- </para>
+ </simpara>
</refsect1><!-- }}} -->
<refsect1 role="seealso"><!-- {{{ -->
diff --git a/reference/inotify/functions/inotify-init.xml b/reference/inotify/functions/inotify-init.xml
index 9a4d424f79e0..bd1043e5c504 100644
--- a/reference/inotify/functions/inotify-init.xml
+++ b/reference/inotify/functions/inotify-init.xml
@@ -12,10 +12,10 @@
<type class="union"><type>resource</type><type>false</type></type><methodname>inotify_init</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Initialize an inotify instance for use with
<function>inotify_add_watch</function>
- </para>
+ </simpara>
</refsect1><!-- }}} -->
<refsect1 role="parameters">
@@ -25,9 +25,9 @@
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
- <para>
+ <simpara>
A stream resource or &false; on error.
- </para>
+ </simpara>
</refsect1><!-- }}} -->
<refsect1 role="examples"><!-- {{{ -->
diff --git a/reference/inotify/functions/inotify-queue-len.xml b/reference/inotify/functions/inotify-queue-len.xml
index 0c257694e70e..713b4c49f158 100644
--- a/reference/inotify/functions/inotify-queue-len.xml
+++ b/reference/inotify/functions/inotify-queue-len.xml
@@ -12,11 +12,11 @@
<type>int</type><methodname>inotify_queue_len</methodname>
<methodparam><type>resource</type><parameter>inotify_instance</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
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.
- </para>
+ </simpara>
</refsect1><!-- }}} -->
<refsect1 role="parameters"><!-- {{{ -->
@@ -25,9 +25,9 @@
<varlistentry>
<term><parameter>inotify_instance</parameter></term>
<listitem>
- <para>
+ <simpara>
&inotify.instance.description;
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,9 +35,9 @@
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a number upper than zero if there are pending events.
- </para>
+ </simpara>
</refsect1><!-- }}} -->
<refsect1 role="seealso"><!-- {{{ -->
diff --git a/reference/inotify/functions/inotify-read.xml b/reference/inotify/functions/inotify-read.xml
index 05e9bc508114..ad3515f46a9b 100644
--- a/reference/inotify/functions/inotify-read.xml
+++ b/reference/inotify/functions/inotify-read.xml
@@ -12,9 +12,9 @@
<type>array</type><methodname>inotify_read</methodname>
<methodparam><type>resource</type><parameter>inotify_instance</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Read inotify events from an inotify instance.
- </para>
+ </simpara>
</refsect1><!-- }}} -->
<refsect1 role="parameters"><!-- {{{ -->
@@ -23,9 +23,9 @@
<varlistentry>
<term><parameter>inotify_instance</parameter></term>
<listitem>
- <para>
+ <simpara>
&inotify.instance.description;
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
diff --git a/reference/inotify/functions/inotify-rm-watch.xml b/reference/inotify/functions/inotify-rm-watch.xml
index a38dd4e210d8..04dd2590562a 100644
--- a/reference/inotify/functions/inotify-rm-watch.xml
+++ b/reference/inotify/functions/inotify-rm-watch.xml
@@ -13,11 +13,11 @@
<methodparam><type>resource</type><parameter>inotify_instance</parameter></methodparam>
<methodparam><type>int</type><parameter>watch_descriptor</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
<function>inotify_rm_watch</function> removes the watch
<parameter>watch_descriptor</parameter> from the inotify instance
<parameter>inotify_instance</parameter>.
- </para>
+ </simpara>
</refsect1><!-- }}} -->
<refsect1 role="parameters"><!-- {{{ -->
@@ -26,17 +26,17 @@
<varlistentry>
<term><parameter>inotify_instance</parameter></term>
<listitem>
- <para>
+ <simpara>
&inotify.instance.description;
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>watch_descriptor</parameter></term>
<listitem>
- <para>
+ <simpara>
Watch to remove from the instance
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -44,9 +44,9 @@
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1><!-- }}} -->
<refsect1 role="seealso"><!-- {{{ -->
diff --git a/reference/inotify/setup.xml b/reference/inotify/setup.xml
index 799588669db1..747befe7483b 100644
--- a/reference/inotify/setup.xml
+++ b/reference/inotify/setup.xml
@@ -1,34 +1,32 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<chapter xml:id="inotify.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="inotify.setup">
&reftitle.setup;
<!-- {{{ Installation -->
<section xml:id="inotify.install">
&reftitle.setup;
- <para>
+ <simpara>
&pecl.moved;
- </para>
- <para>
+ </simpara>
+ <simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;inotify">&url.pecl.package;inotify</link>.
- </para>
+ </simpara>
</section>
<!-- }}} -->
<!-- {{{ Resources -->
<section xml:id="inotify.resources">
&reftitle.resources;
- <para>
+ <simpara>
This extension defines a stream resource returned by
<function>inotify_init</function>.
- </para>
+ </simpara>
</section>
<!-- }}} -->
</chapter>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -49,4 +47,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-