diff options
| author | Lennart Poettering <lennart@poettering.net> | 2018-08-03 16:43:30 +0200 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2018-08-03 17:36:11 +0200 |
| commit | 64a7ef8bc06b5dcfcd9f99ea10a43bde75c4370f (patch) | |
| tree | ab5905268e9686f76a5e9d35cd1352353bdfb8bc /man/sd-journal.xml | |
| parent | af560fc1da26a7d0e94b0d56a3cd2a14d2b082c8 (diff) | |
| download | systemd-64a7ef8bc06b5dcfcd9f99ea10a43bde75c4370f.tar.gz | |
man: be more explicit about thread safety of sd_journal
Triggered by https://bugzilla.redhat.com/show_bug.cgi?id=1609349
This adds two generic paragaphs we include via xinclude. One is the
"strict" version, which contains wording saying that we are thread
agnostic and what that means. And the other is the "safe" version, for
the cases we provide fully safety.
Let's then change most man pages to use either of these generic
paragraphs. With one exception: man/sd_journal_get_catalog.xml contains
both kinds of function, we hence use manual wording.
Diffstat (limited to 'man/sd-journal.xml')
| -rw-r--r-- | man/sd-journal.xml | 17 |
1 files changed, 8 insertions, 9 deletions
diff --git a/man/sd-journal.xml b/man/sd-journal.xml index 8bfcb90ca0..3fa6c75b7e 100644 --- a/man/sd-journal.xml +++ b/man/sd-journal.xml @@ -77,16 +77,15 @@ <refsect1> <title>Thread safety</title> - <para>Functions that operate on the <structname>sd_journal</structname> object are thread - agnostic — given <structname>sd_journal</structname> pointer may only be used from one thread at - a time, but multiple threads may use multiple such objects safely. Other functions — - those that are used to send entries to the journal, like - <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry> - and similar, or those that are used to retrieve global information like - <citerefentry><refentrytitle>sd_journal_stream_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry> - and + <para>Functions that operate on <structname>sd_journal</structname> objects are thread agnostic — given + <structname>sd_journal</structname> pointer may only be used from one specific thread at all times (and it has to + be the very same one during the entire lifetime of the object), but multiple, independent threads may use multiple, + independent objects safely. Other functions — those that are used to send entries to the journal, like + <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry> and similar, + or those that are used to retrieve global information like + <citerefentry><refentrytitle>sd_journal_stream_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry> and <citerefentry><refentrytitle>sd_journal_get_catalog_for_message_id</refentrytitle><manvolnum>3</manvolnum></citerefentry> - — are thread-safe and may be called from multiple threads in parallel.</para> + — are fully thread-safe and may be called from multiple threads in parallel.</para> </refsect1> <xi:include href="libsystemd-pkgconfig.xml" /> |