chiark / gitweb /
hashmap: return more information from resize_buckets()
[elogind.git] / man / sd_event_new.xml
index 1fe1820..d392ed3 100644 (file)
@@ -83,40 +83,40 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
     <para><function>sd_event_new()</function> allocates a new event
     loop object. The event loop object is returned in the
-    <parameter>event</parameter> parameter. After use drop
+    <parameter>event</parameter> parameter. After use, drop
     the returned reference with
     <function>sd_event_unref()</function>. When the last reference is
-    dropped the event loop is freed.</para>
+    dropped, the object is freed.</para>
 
     <para><function>sd_event_default()</function> acquires a reference
     to the default event loop object of the calling thread, possibly
     allocating a new object if no default event loop object has been
-    allocated yet for the thread. After use drop the returned
-    referened with <function>sd_event_unref()</function>. When the
-    last reference is dropped the event loop is freed. If this
+    allocated yet for the thread. After use, drop the returned
+    reference with <function>sd_event_unref()</function>. When the
+    last reference is dropped, the event loop is freed. If this
     function is called while the object returned from a previous call
     from the same thread is still referenced, the same object is
     returned again, but the reference is increased by one. It is
     recommended to use this call instead of
     <function>sd_event_new()</function> in order to share event loop
     objects between various components that are dispatched in the same
-    thread. All threads either have no or one default event loops
-    associated, but never more.</para>
+    thread. All threads have exactly either zero or one default event loop
+    objects associated, but never more.</para>
 
     <para><function>sd_event_ref()</function> increases the reference
-    counter of the specified event loop object by one.</para>
+    count of the specified event loop object by one.</para>
 
     <para><function>sd_event_unref()</function> decreases the
-    reference counter of the specified event loop object by one. If
-    the counter hits zero the event loop object is freed. Not that it
-    is freed regardless if it is the default event loop object of a
+    reference count of the specified event loop object by one. If
+    the count hits zero, the object is freed. Note that it
+    is freed regardless of whether it is the default event loop object for a
     thread or not. This means that allocating an event loop with
-    <function>sd_event_default()</function>, then releasing it and
+    <function>sd_event_default()</function>, then releasing it, and
     then acquiring a new one with
     <function>sd_event_default()</function> will result in two
-    distinct objects. Note that in order to free an event loop object
+    distinct objects. Note that in order to free an event loop object,
     all remaining event sources of the event loop also need to be
-    freed as they each keep a reference to it.</para>
+    freed as each keeps a reference to it.</para>
   </refsect1>
 
   <refsect1>
@@ -128,7 +128,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     code. <function>sd_event_ref()</function> always returns a pointer
     to the event loop object passed
     in. <function>sd_event_unref()</function> always returns
-    NULL.</para>
+    <constant>NULL</constant>.</para>
   </refsect1>
 
   <refsect1>
@@ -138,13 +138,13 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
 
     <variablelist>
       <varlistentry>
-        <term><varname>-ENOMEM</varname></term>
+        <term><constant>-ENOMEM</constant></term>
 
-        <listitem><para>Not enough memory to allocate object</para></listitem>
+        <listitem><para>Not enough memory to allocate the object.</para></listitem>
       </varlistentry>
 
       <varlistentry>
-        <term><varname>-EMFILE</varname></term>
+        <term><constant>-EMFILE</constant></term>
 
         <listitem><para>The maximum number of event loops has been allocated.</para></listitem>
 
@@ -158,7 +158,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     <para><function>sd_event_new()</function> and the other functions
     described here are available as a shared library, which can be
     compiled and linked to with the
-    <constant>libsystemd</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+    <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
     file.</para>
   </refsect1>