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/threads-aware.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/threads-aware.xml')
| -rw-r--r-- | man/threads-aware.xml | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/man/threads-aware.xml b/man/threads-aware.xml new file mode 100644 index 0000000000..7985f4acd1 --- /dev/null +++ b/man/threads-aware.xml @@ -0,0 +1,17 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> + +<!-- + SPDX-License-Identifier: LGPL-2.1+ +--> + +<refsect1> + +<para id="strict">All functions listed here are thread-agnostic and only a single specific thread may operate on a +given object during its entire lifetime. It's safe to allocate multiple independent objects and use each from a +specific thread in parallel. However, it's not safe to allocate such an object in one thread, and operate or free it +from any other, even if locking is used to ensure these threads don't operate on it at the very same time.</para> + +<para id="safe">All functions listed here are thread-safe and may be called in parallel from multiple threads.</para> + +</refsect1> |