man: document explicitly that sd_journal_stream_fd() never shares fds
authorLennart Poettering <lennart@poettering.net>
Tue, 23 Jan 2018 18:06:21 +0000 (19:06 +0100)
committerLennart Poettering <lennart@poettering.net>
Tue, 23 Jan 2018 18:06:21 +0000 (19:06 +0100)
Also, clarify that O_NONBLOCK is turned off and that the fd is only
half-open.

man/sd_journal_stream_fd.xml

index b9da483..abd4a91 100644 (file)
 
     <para>It is recommended that applications log UTF-8 messages only
     with this API, but this is not enforced.</para>
+
+    <para>Each invocation of <function>sd_journal_stream_fd()</function> allocates a new log stream file descriptor,
+    that is not shared with prior or later invocations. The file descriptor is write-only (its reading direction is
+    shut down), and <constant>O_NONBLOCK</constant> is turned off initially.</para>
   </refsect1>
 
   <refsect1>