]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/sd_event_wait.xml
tree-wide: "<n>bit" → "<n>-bit"
[thirdparty/systemd.git] / man / sd_event_wait.xml
index f01d18e94e10a0226181e6a3c42748dd4a51c000..dedf3c40be5ed3dea888b53c61a8f61d88550a6e 100644 (file)
@@ -1,10 +1,7 @@
 <?xml version='1.0'?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
-"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
-
-<!--
-  SPDX-License-Identifier: LGPL-2.1+
--->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
 
 <refentry id="sd_event_wait" xmlns:xi="http://www.w3.org/2001/XInclude">
 
     of the states described below.</para>
 
     <para><function>sd_event_get_iteration()</function> may be used to determine the current iteration of the event
-    loop. It returns an unsigned 64bit integer containing a counter that increases monotonically with each iteration of
+    loop. It returns an unsigned 64-bit integer containing a counter that increases monotonically with each iteration of
     the event loop, starting with 0. The counter is increased at the time of the
     <function>sd_event_prepare()</function> invocation.</para>
 
   <refsect1>
     <title>Return Value</title>
 
-    <para>On success, these functions return 0 or a positive integer.
-    On failure, they return a negative errno-style error code. In case
-    of <function>sd_event_prepare()</function> and
-    <function>sd_event_wait()</function>, a positive, non-zero return
-    code indicates that events are ready to be processed and zero
-    indicates that no events are ready. In case of
-    <function>sd_event_dispatch()</function>, a positive, non-zero
-    return code indicates that the event loop returned to its initial
-    state and zero indicates the event loop has
-    exited. <function>sd_event_get_state()</function> returns a
-    positive or zero state on success.</para>
-  </refsect1>
+    <para>On success, these functions return 0 or a positive integer.  On failure, they return a negative
+    errno-style error code. In case of <function>sd_event_prepare()</function> and
+    <function>sd_event_wait()</function>, a positive, non-zero return code indicates that events are ready to
+    be processed and zero indicates that no events are ready. In case of
+    <function>sd_event_dispatch()</function>, a positive, non-zero return code indicates that the event loop
+    returned to its initial state and zero indicates the event loop has
+    exited. <function>sd_event_get_state()</function> returns a positive or zero state on success.</para>
 
-  <refsect1>
-    <title>Errors</title>
+    <refsect2>
+      <title>Errors</title>
 
-    <para>Returned errors may indicate the following problems:</para>
+      <para>Returned errors may indicate the following problems:</para>
 
-    <variablelist>
-      <varlistentry>
-        <term><constant>-EINVAL</constant></term>
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
 
-        <listitem><para>The <parameter>event</parameter> parameter is
-        invalid or <constant>NULL</constant>.</para></listitem>
-      </varlistentry>
+          <listitem><para>The <parameter>event</parameter> parameter is invalid or <constant>NULL</constant>.
+          </para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-EBUSY</constant></term>
+        <varlistentry>
+          <term><constant>-EBUSY</constant></term>
 
-        <listitem><para>The event loop object is not in the right
-        state.</para></listitem>
-      </varlistentry>
+          <listitem><para>The event loop object is not in the right state.</para></listitem>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ESTALE</constant></term>
+        <varlistentry>
+          <term><constant>-ESTALE</constant></term>
 
-        <listitem><para>The event loop is already terminated.</para></listitem>
+          <listitem><para>The event loop is already terminated.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-      <varlistentry>
-        <term><constant>-ECHILD</constant></term>
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
 
-        <listitem><para>The event loop has been created in a different process.</para></listitem>
+          <listitem><para>The event loop has been created in a different process, library or module instance.</para></listitem>
 
-      </varlistentry>
+        </varlistentry>
 
-    </variablelist>
+      </variablelist>
 
-    <para>Other errors are possible, too.</para>
+      <para>Other errors are possible, too.</para>
+    </refsect2>
   </refsect1>
 
   <xi:include href="libsystemd-pkgconfig.xml" />