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_open.xml | |
parent | update TODO (diff) | |
download | systemd-64a7ef8bc06b5dcfcd9f99ea10a43bde75c4370f.tar.xz systemd-64a7ef8bc06b5dcfcd9f99ea10a43bde75c4370f.zip |
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_open.xml')
-rw-r--r-- | man/sd_journal_open.xml | 13 |
1 files changed, 4 insertions, 9 deletions
diff --git a/man/sd_journal_open.xml b/man/sd_journal_open.xml index 9f600b223f..cf787b7ea1 100644 --- a/man/sd_journal_open.xml +++ b/man/sd_journal_open.xml @@ -6,7 +6,8 @@ SPDX-License-Identifier: LGPL-2.1+ --> -<refentry id="sd_journal_open"> +<refentry id="sd_journal_open" + xmlns:xi="http://www.w3.org/2001/XInclude"> <refentryinfo> <title>sd_journal_open</title> @@ -184,15 +185,9 @@ <refsect1> <title>Notes</title> - <para>All functions listed here are thread-agnostic and only a single thread may operate - on a given <structname>sd_journal</structname> object.</para> + <xi:include href="threads-aware.xml" xpointer="strict"/> - <para>The <function>sd_journal_open()</function>, - <function>sd_journal_open_directory()</function> and - <function>sd_journal_close()</function> interfaces are available - as a shared library, which can be compiled and linked to with the - <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> - file.</para> + <xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/> </refsect1> <refsect1> |