summaryrefslogtreecommitdiff
path: root/man/sd_journal_get_fd.xml
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2018-01-20 14:23:54 +1100
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2018-01-20 15:11:54 +1100
commit89f552c0e26afd65fc0c825f843aeedc5d8ae29f (patch)
tree87c406a8f756fc1ad18dc2f7503edfcdc4db2712 /man/sd_journal_get_fd.xml
parent000b1ba5610524c1e5a28ec48a9dc990b9b301ac (diff)
downloadsystemd-89f552c0e26afd65fc0c825f843aeedc5d8ae29f.tar.gz
man: document signal unsafeness of journal functions
Fixes #7912.
Diffstat (limited to 'man/sd_journal_get_fd.xml')
-rw-r--r--man/sd_journal_get_fd.xml14
1 files changed, 14 insertions, 0 deletions
diff --git a/man/sd_journal_get_fd.xml b/man/sd_journal_get_fd.xml
index b162b2bf11..24ececd9cb 100644
--- a/man/sd_journal_get_fd.xml
+++ b/man/sd_journal_get_fd.xml
@@ -231,6 +231,20 @@ else {
</refsect1>
<refsect1>
+ <title>Signal safety</title>
+
+ <para>In general, <function>sd_journal_get_fd()</function>,
+ <function>sd_journal_get_events()</function>, and <function>sd_journal_get_timeout()</function>
+ are <emphasis>not</emphasis> "async signal safe" in the meaning of
+ <citerefentry project='man-pages'><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
+ Nevertheless, only the first call to any of those three functions performs unsafe operations, so
+ subsequent calls <emphasis>are</emphasis> safe.</para>
+
+ <para><function>sd_journal_process()</function> and <function>sd_journal_wait()</function> are not
+ safe. <function>sd_journal_reliable_fd()</function> is safe.</para>
+ </refsect1>
+
+ <refsect1>
<title>Notes</title>
<para>The <function>sd_journal_get_fd()</function>,