systemd/man/threads-aware.xml

<?xml version="1.0"?>
<!DOCTYPE refentry 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>
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. 2018-08-03 17:43:30 +03:00			`<?xml version="1.0"?>`
man: use same header for all files The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book\|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml 2019-03-14 16:40:58 +03:00			`<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"`
			`"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">`
man: standarize on one-line license header No need to waste space, and uniformity is good. $ perl -i -0pe 's\|\n+<!--\sSPDX-License-Identifier: LGPL-2.1..\s-->\|\n<!-- SPDX-License-Identifier: LGPL-2.1+ -->\|gms' man/*.xml 2019-03-14 16:29:37 +03:00			`<!-- SPDX-License-Identifier: LGPL-2.1+ -->`
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. 2018-08-03 17:43:30 +03:00
			`<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>`