From: Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Date: Thu, 16 Nov 2023 10:12:00 +0000 (+0100)
Subject: man/sd_bus_process: fix confusion about "synchronous"
X-Git-Tag: v255-rc4~64^2~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=83d0edf5651b0e5861926363ce65f3e4a69fe08a;p=thirdparty%2Fsystemd.git

man/sd_bus_process: fix confusion about "synchronous"

An event loop is not "synchronous". So we shouldn't say that the client must
"synchrounusly poll" if we recommend an event loop. Let's just say it should
poll, and say that "sd_bus_wait()" is blocking, which is clearer and more
correct than "synchronous".
---

diff --git a/man/sd_bus_process.xml b/man/sd_bus_process.xml
index f16b30ec6c9..8e142dd97a7 100644
--- a/man/sd_bus_process.xml
+++ b/man/sd_bus_process.xml
@@ -41,14 +41,14 @@
   <refsect1>
     <title>Description</title>
 
-    <para><function>sd_bus_process()</function> drives the connection between the client and the message bus. That is,
-    it handles connecting, authentication, and message processing. When invoked pending I/O work is executed, and
-    queued incoming messages are dispatched to registered callbacks. Each time it is invoked a single operation is
-    executed. It returns zero when no operations were pending and positive if a message was processed. When zero is
-    returned the caller should synchronously poll for I/O events before calling into
-    <function>sd_bus_process()</function> again. For that either use the simple, synchronous
-    <citerefentry><refentrytitle>sd_bus_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry> call, or hook up
-    the bus connection object to an external or manual event loop using
+    <para><function>sd_bus_process()</function> drives the connection between the client and the message bus.
+    That is, it handles connecting, authentication, and processing of messages. When invoked, pending I/O
+    work is executed, and queued incoming messages are dispatched to registered callbacks. Each time it is
+    invoked a single operation is executed. It returns zero when no operations were pending and positive if a
+    message was processed. When zero is returned the caller should poll for I/O events before calling into
+    <function>sd_bus_process()</function> again. For that either use the simple, blocking
+    <citerefentry><refentrytitle>sd_bus_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry> call, or
+    hook up the bus connection object to an external or manual event loop using
     <citerefentry><refentrytitle>sd_bus_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
     </para>