man: document sd_event_source_set_floating()

Let's make sure we get back to 100% man page documentation coverage of
our sd-event APIs. We are bad enough at the others, let's get these ones
right at least.

diff --git a/man/rules/meson.build b/man/rules/meson.build
index 8eba0a52ce5d3a24914c53c0906d3528bcdab206..20c3d09da08ec8b0dd643764d1b543799007be48 100644 (file)
--- a/man/rules/meson.build
+++ b/man/rules/meson.build
@@ -437,6 +437,7 @@ manpages = [
    'SD_EVENT_ONESHOT',
    'sd_event_source_get_enabled'],
   ''],
+ ['sd_event_source_set_floating', '3', ['sd_event_source_get_floating'], ''],
  ['sd_event_source_set_prepare', '3', [], ''],
  ['sd_event_source_set_priority',
   '3',

diff --git a/man/sd_event_add_child.xml b/man/sd_event_add_child.xml
index 23fa78ea7294e9a3e239ac06cb85058021f69f9b..509803d5c170272f66c5b84c0d1c2e9b4965243a 100644 (file)
--- a/man/sd_event_add_child.xml
+++ b/man/sd_event_add_child.xml
@@ -213,6 +213,7 @@
       <citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry project='man-pages'><refentrytitle>waitid</refentrytitle><manvolnum>2</manvolnum></citerefentry>
     </para>
   </refsect1>

diff --git a/man/sd_event_add_defer.xml b/man/sd_event_add_defer.xml
index 636c61e99c8de1485d2e0a5e272983bb1d719a81..92be8353e647d08584f7c6d8de9b62712401dbb2 100644 (file)
--- a/man/sd_event_add_defer.xml
+++ b/man/sd_event_add_defer.xml
@@ -183,6 +183,7 @@
       <citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd_event_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>
     </para>
   </refsect1>

diff --git a/man/sd_event_add_inotify.xml b/man/sd_event_add_inotify.xml
index 3c9f2fbe3eb6d1511e52c6dedd57b7b28c52930c..8860699db3d085dd6f8c4e7f2c16b674874d3b88 100644 (file)
--- a/man/sd_event_add_inotify.xml
+++ b/man/sd_event_add_inotify.xml
@@ -183,6 +183,7 @@
       <citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry project='man-pages'><refentrytitle>waitid</refentrytitle><manvolnum>2</manvolnum></citerefentry>
     </para>
   </refsect1>

diff --git a/man/sd_event_add_io.xml b/man/sd_event_add_io.xml
index 398b938e3c21809795c9303325c4428a34182641..35d02a17000c8dac6f08ccee3f1e80ba77e6c1b2 100644 (file)
--- a/man/sd_event_add_io.xml
+++ b/man/sd_event_add_io.xml
@@ -296,6 +296,7 @@
       <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd_event_source_get_pending</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry project='man-pages'><refentrytitle>epoll_ctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
       <citerefentry project='man-pages'><refentrytitle>epoll</refentrytitle><manvolnum>7</manvolnum></citerefentry>
     </para>

diff --git a/man/sd_event_add_signal.xml b/man/sd_event_add_signal.xml
index 9bf777c10714e9281aa5550dc0a0fcf7505d22fb..a7148ca8dd13e3d6a81e73d6f4a0032dca356c48 100644 (file)
--- a/man/sd_event_add_signal.xml
+++ b/man/sd_event_add_signal.xml
@@ -187,6 +187,7 @@
       <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry project='man-pages'><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
       <citerefentry project='man-pages'><refentrytitle>signalfd</refentrytitle><manvolnum>2</manvolnum></citerefentry>
     </para>

diff --git a/man/sd_event_add_time.xml b/man/sd_event_add_time.xml
index 731636451c7265f3df9ad9bbce1a6665fd02d993..8d3511ef638a3052222cd8f526e8ad9193cb3266 100644 (file)
--- a/man/sd_event_add_time.xml
+++ b/man/sd_event_add_time.xml
@@ -278,6 +278,7 @@
       <citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
       <citerefentry project='man-pages'><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
       <citerefentry project='man-pages'><refentrytitle>timerfd_create</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
       <citerefentry project='man-pages'><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>

diff --git a/man/sd_event_source_set_floating.xml b/man/sd_event_source_set_floating.xml
new file mode 100644 (file)
index 0000000..89341d1
--- /dev/null
+++ b/man/sd_event_source_set_floating.xml
@@ -0,0 +1,118 @@
+<?xml version='1.0'?>
+<!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+ -->
+
+<refentry id="sd_event_source_set_floating" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+  <refentryinfo>
+    <title>sd_event_source_set_floating</title>
+    <productname>systemd</productname>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>sd_event_source_set_floating</refentrytitle>
+    <manvolnum>3</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>sd_event_source_set_floating</refname>
+    <refname>sd_event_source_get_floating</refname>
+
+    <refpurpose>Set or retrieve 'floating' state of event sources</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <funcsynopsis>
+      <funcsynopsisinfo>#include &lt;systemd/sd-event.h&gt;</funcsynopsisinfo>
+
+      <funcprototype>
+        <funcdef>int <function>sd_event_source_set_floating</function></funcdef>
+        <paramdef>sd_event_source *<parameter>source</parameter></paramdef>
+        <paramdef>int <parameter>floating</parameter></paramdef>
+      </funcprototype>
+
+      <funcprototype>
+        <funcdef>int <function>sd_event_source_get_floating</function></funcdef>
+        <paramdef>sd_event_source *<parameter>source</parameter></paramdef>
+      </funcprototype>
+
+    </funcsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para><function>sd_event_source_set_floating()</function> takes a boolean and sets the 'floating' state
+    of the specified event source object. This is used to change the direction of reference counts for the
+    object and the event loop it is associated with. In non-floating mode, the event source object holds a
+    reference to the event loop object, but not vice versa. The creator of the event source object must hold
+    a reference to it as long as the source should exist. In floating mode, the event loop holds a reference
+    to the source object, and will decrease the reference count when being freed. This means that a reference
+    to the event loop should be held to prevent both from being destroyed.</para>
+
+    <para>Various calls that allocate event source objects (i.e.
+    <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+    <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry> and
+    similar) will automatically set an event source object to 'floating' mode if the caller passed
+    <constant>NULL</constant> in the parameter used to return a reference to the event source object.
+    Nevertheless, it may be necessary to gain temporary access to the source object, for example to adjust
+    event source properties after allocation (e.g. its priority or description string). In those cases the
+    object may be created in non-floating mode, and the returned reference used to adjust the properties, and
+    the object marked as floating afterwards, and the reference in the caller dropped.</para>
+
+    <para><function>sd_event_source_get_floating()</function> may be used to query the current 'floating'
+    state of the event source object <parameter>source</parameter>. It returns zero if 'floating' mode is
+    off, positive if it is on.</para>
+  </refsect1>
+
+  <refsect1>
+    <title>Return Value</title>
+
+    <para>On success, <function>sd_event_source_set_floating()</function> and
+    <function>sd_event_source_get_floating()</function> return a non-negative integer. On failure, they
+    return a negative errno-style error code.</para>
+
+    <refsect2>
+      <title>Errors</title>
+
+      <para>Returned errors may indicate the following problems:</para>
+
+      <variablelist>
+        <varlistentry>
+          <term><constant>-EINVAL</constant></term>
+
+          <listitem><para><parameter>source</parameter> is not a valid pointer to an
+          <structname>sd_event_source</structname> object.</para></listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term><constant>-ECHILD</constant></term>
+
+          <listitem><para>The event loop has been created in a different process.</para></listitem>
+
+        </varlistentry>
+
+      </variablelist>
+    </refsect2>
+  </refsect1>
+
+  <xi:include href="libsystemd-pkgconfig.xml" />
+
+  <refsect1>
+    <title>See Also</title>
+
+    <para>
+      <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+    </para>
+  </refsect1>
+
+</refentry>