diff options
author | Lennart Poettering <lennart@poettering.net> | 2011-09-22 21:13:41 +0200 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2011-09-22 21:16:52 +0200 |
commit | 71e6c1cf47c35cc5a58cefaabe4f6848d6f09501 (patch) | |
tree | a45323ff6aa1a6263ba41a16473c553376cbb383 | |
parent | 5375410bb2ed11a6a9e37063c0a551a7bf75338f (diff) |
man: document that sd-daemon.[ch] is now available as shared library
-rw-r--r-- | man/sd-daemon.xml | 19 | ||||
-rw-r--r-- | man/sd_booted.xml | 26 | ||||
-rw-r--r-- | man/sd_is_fifo.xml | 20 | ||||
-rw-r--r-- | man/sd_listen_fds.xml | 26 | ||||
-rw-r--r-- | man/sd_notify.xml | 23 | ||||
-rw-r--r-- | man/sd_readahead.xml | 26 |
6 files changed, 85 insertions, 55 deletions
diff --git a/man/sd-daemon.xml b/man/sd-daemon.xml index cbfe28f842..3f428f4022 100644 --- a/man/sd-daemon.xml +++ b/man/sd-daemon.xml @@ -129,17 +129,20 @@ resp. <ulink url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.h"/></para> <para>These APIs are implemented in the reference - implementation's drop-in - <filename>sd-daemon.c</filename> and - <filename>sd-daemon.h</filename> files. It is - recommended that applications consuming these APIs copy - the implementation into their source tree, either - verbatim or in excerpts. These interfaces are - currently not available in a dynamic library.</para> + implementation's <filename>sd-daemon.c</filename> and + <filename>sd-daemon.h</filename> files. These + interfaces are available as shared library, which can + be compiled and linked to with the + <literal>libsystemd-daemon</literal> + <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> + file. Alternatively, applications consuming these APIs + may copy the implementation into their source tree, + either verbatim or in excerpts.</para> <para>The functions directly related to new-style daemons become NOPs when -DDISABLE_SYSTEMD is set - during compilation. In addition, if + during compilation and the reference implementation is + used as drop-in files. In addition, if <filename>sd-daemon.c</filename> is compiled on non-Linux systems they become NOPs.</para> </refsect1> diff --git a/man/sd_booted.xml b/man/sd_booted.xml index 841ee1d479..ebcde36b48 100644 --- a/man/sd_booted.xml +++ b/man/sd_booted.xml @@ -98,17 +98,23 @@ url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.h"/></para> <para><function>sd_booted()</function> is implemented - in the reference implementation's drop-in + in the reference implementation's <filename>sd-daemon.c</filename> and - <filename>sd-daemon.h</filename> files. It is - recommended that applications consuming these APIs - copy the implementation into their source tree. For - more details about the reference implementation see - <citerefentry><refentrytitle>sd_daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry></para> - - <para>If -DDISABLE_SYSTEMD is set during compilation - this function will always return 0 and otherwise - become a NOP.</para> + <filename>sd-daemon.h</filename> files. These + interfaces are available as shared library, which can + be compiled and linked to with the + <literal>libsystemd-daemon</literal> + <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> + file. Alternatively, applications consuming these APIs + may copy the implementation into their source + tree. For more details about the reference + implementation see + <citerefentry><refentrytitle>sd_daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> + + <para>If the reference implementation is used as + drop-in files and -DDISABLE_SYSTEMD is set during + compilation this function will always return 0 and + otherwise become a NOP.</para> </refsect1> <refsect1> diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml index 251f45ce0f..f6fafabc39 100644 --- a/man/sd_is_fifo.xml +++ b/man/sd_is_fifo.xml @@ -178,7 +178,7 @@ <filename>getsockname()</filename> to check the file descriptor type and where it is bound to.</para> - <para>For details about the algorithm check the + <para>For details about the algorithms check the liberally licensed reference implementation sources: <ulink url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.c"/> resp. <ulink @@ -186,13 +186,17 @@ <para><function>sd_is_fifo()</function> and the related functions are implemented in the reference - implementation's drop-in - <filename>sd-daemon.c</filename> and - <filename>sd-daemon.h</filename> files. It is - recommended that applications consuming these APIs - copy the implementation into their source tree. For - more details about the reference implementation see - <citerefentry><refentrytitle>sd_daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry></para> + implementation's <filename>sd-daemon.c</filename> and + <filename>sd-daemon.h</filename> files. These + interfaces are available as shared library, which can + be compiled and linked to with the + <literal>libsystemd-daemon</literal> + <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> + file. Alternatively, applications consuming these APIs + may copy the implementation into their source + tree. For more details about the reference + implementation see + <citerefentry><refentrytitle>sd_daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> <para>These functions continue to work as described, even if -DDISABLE_SYSTEMD is set during diff --git a/man/sd_listen_fds.xml b/man/sd_listen_fds.xml index 128d859b97..3276aff63d 100644 --- a/man/sd_listen_fds.xml +++ b/man/sd_listen_fds.xml @@ -145,17 +145,23 @@ url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.h"/></para> <para><function>sd_listen_fds()</function> is - implemented in the reference implementation's drop-in + implemented in the reference implementation's <filename>sd-daemon.c</filename> and - <filename>sd-daemon.h</filename> files. It is - recommended that applications consuming these APIs - copy the implementation into their source tree. For - more details about the reference implementation see - <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry></para> - - <para>If -DDISABLE_SYSTEMD is set during compilation - this function will always return 0 and otherwise - become a NOP.</para> + <filename>sd-daemon.h</filename> files. These + interfaces are available as shared library, which can + be compiled and linked to with the + <literal>libsystemd-daemon</literal> + <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> + file. Alternatively, applications consuming these APIs + may copy the implementation into their source + tree. For more details about the reference + implementation see + <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> + + <para>If the reference implementation is used as + drop-in files and -DDISABLE_SYSTEMD is set during + compilation this function will always return 0 and + otherwise become a NOP.</para> </refsect1> <refsect1> diff --git a/man/sd_notify.xml b/man/sd_notify.xml index c060bbad27..dd0ba935d6 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -206,7 +206,7 @@ datagram is accompanied by the process credentials of the sending daemon, using SCM_CREDENTIALS.</para> - <para>For details about the algorithm check the + <para>For details about the algorithms check the liberally licensed reference implementation sources: <ulink url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.c"/> resp. <ulink @@ -214,17 +214,22 @@ <para><function>sd_notify()</function> and <function>sd_notifyf()</function> are implemented in - the reference implementation's drop-in + the reference implementation's <filename>sd-daemon.c</filename> and - <filename>sd-daemon.h</filename> files. It is - recommended that applications consuming these APIs - copy the implementation into their source tree. For + <filename>sd-daemon.h</filename> files. These + interfaces are available as shared library, which can + be compiled and linked to with the + <literal>libsystemd-daemon</literal> + <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> + file. Alternatively, applications consuming these APIs + may copy the implementation into their source tree. For more details about the reference implementation see - <citerefentry><refentrytitle>sd_daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry></para> + <citerefentry><refentrytitle>sd_daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> - <para>If -DDISABLE_SYSTEMD is set during compilation - this function will always return 0 and otherwise - become a NOP.</para> + <para>If the reference implementation is used as + drop-in files and -DDISABLE_SYSTEMD is set during + compilation these functions will always return 0 and + otherwise become a NOP.</para> </refsect1> <refsect1> diff --git a/man/sd_readahead.xml b/man/sd_readahead.xml index 004608dfba..88b135b7ec 100644 --- a/man/sd_readahead.xml +++ b/man/sd_readahead.xml @@ -134,17 +134,23 @@ url="http://cgit.freedesktop.org/systemd/tree/src/sd-readahead.h"/></para> <para><function>sd_readahead()</function> is - implemented in the reference implementation's drop-in + implemented in the reference implementation's <filename>sd-readahead.c</filename> and - <filename>sd-readahead.h</filename> files. It is - recommended that applications consuming this API copy - the implementation into their source tree. For more - details about the reference implementation see - <citerefentry><refentrytitle>sd-readahead</refentrytitle><manvolnum>7</manvolnum></citerefentry></para> - - <para>If -DDISABLE_SYSTEMD is set during compilation - this function will always return 0 and otherwise - become a NOP.</para> + <filename>sd-readahead.h</filename> files. These + interfaces are available as shared library, which can + be compiled and linked to with the + <literal>libsystemd-daemon</literal> + <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> + file. Alternatively, applications consuming this API + may copy the implementation into their source + tree. For more details about the reference + implementation see + <citerefentry><refentrytitle>sd-readahead</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> + + <para>If the reference implementation is used as + drop-in files and -DDISABLE_SYSTEMD is set during + compilation this function will always return 0 and + otherwise become a NOP.</para> </refsect1> <refsect1> |