From: Lennart Poettering Date: Thu, 22 Sep 2011 19:13:41 +0000 (+0200) Subject: man: document that sd-daemon.[ch] is now available as shared library X-Git-Tag: v36~24 X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;ds=inline;h=71e6c1cf47c35cc5a58cefaabe4f6848d6f09501;p=elogind.git man: document that sd-daemon.[ch] is now available as shared library --- diff --git a/man/sd-daemon.xml b/man/sd-daemon.xml index cbfe28f84..3f428f402 100644 --- a/man/sd-daemon.xml +++ b/man/sd-daemon.xml @@ -129,17 +129,20 @@ resp. These APIs are implemented in the reference - implementation's drop-in - sd-daemon.c and - sd-daemon.h 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. + implementation's sd-daemon.c and + sd-daemon.h files. These + interfaces are available as shared library, which can + be compiled and linked to with the + libsystemd-daemon + pkg-config1 + file. Alternatively, applications consuming these APIs + may copy the implementation into their source tree, + either verbatim or in excerpts. 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 sd-daemon.c is compiled on non-Linux systems they become NOPs. diff --git a/man/sd_booted.xml b/man/sd_booted.xml index 841ee1d47..ebcde36b4 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"/> sd_booted() is implemented - in the reference implementation's drop-in + in the reference implementation's sd-daemon.c and - sd-daemon.h files. It is - recommended that applications consuming these APIs - copy the implementation into their source tree. For - more details about the reference implementation see - sd_daemon7 - - If -DDISABLE_SYSTEMD is set during compilation - this function will always return 0 and otherwise - become a NOP. + sd-daemon.h files. These + interfaces are available as shared library, which can + be compiled and linked to with the + libsystemd-daemon + pkg-config1 + file. Alternatively, applications consuming these APIs + may copy the implementation into their source + tree. For more details about the reference + implementation see + sd_daemon7. + + 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. diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml index 251f45ce0..f6fafabc3 100644 --- a/man/sd_is_fifo.xml +++ b/man/sd_is_fifo.xml @@ -178,7 +178,7 @@ getsockname() to check the file descriptor type and where it is bound to. - For details about the algorithm check the + For details about the algorithms check the liberally licensed reference implementation sources: resp. sd_is_fifo() and the related functions are implemented in the reference - implementation's drop-in - sd-daemon.c and - sd-daemon.h files. It is - recommended that applications consuming these APIs - copy the implementation into their source tree. For - more details about the reference implementation see - sd_daemon7 + implementation's sd-daemon.c and + sd-daemon.h files. These + interfaces are available as shared library, which can + be compiled and linked to with the + libsystemd-daemon + pkg-config1 + file. Alternatively, applications consuming these APIs + may copy the implementation into their source + tree. For more details about the reference + implementation see + sd_daemon7. 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 128d859b9..3276aff63 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"/> sd_listen_fds() is - implemented in the reference implementation's drop-in + implemented in the reference implementation's sd-daemon.c and - sd-daemon.h files. It is - recommended that applications consuming these APIs - copy the implementation into their source tree. For - more details about the reference implementation see - sd-daemon7 - - If -DDISABLE_SYSTEMD is set during compilation - this function will always return 0 and otherwise - become a NOP. + sd-daemon.h files. These + interfaces are available as shared library, which can + be compiled and linked to with the + libsystemd-daemon + pkg-config1 + file. Alternatively, applications consuming these APIs + may copy the implementation into their source + tree. For more details about the reference + implementation see + sd-daemon7. + + 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. diff --git a/man/sd_notify.xml b/man/sd_notify.xml index c060bbad2..dd0ba935d 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. - For details about the algorithm check the + For details about the algorithms check the liberally licensed reference implementation sources: resp. sd_notify() and sd_notifyf() are implemented in - the reference implementation's drop-in + the reference implementation's sd-daemon.c and - sd-daemon.h files. It is - recommended that applications consuming these APIs - copy the implementation into their source tree. For + sd-daemon.h files. These + interfaces are available as shared library, which can + be compiled and linked to with the + libsystemd-daemon + pkg-config1 + file. Alternatively, applications consuming these APIs + may copy the implementation into their source tree. For more details about the reference implementation see - sd_daemon7 + sd_daemon7. - If -DDISABLE_SYSTEMD is set during compilation - this function will always return 0 and otherwise - become a NOP. + 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. diff --git a/man/sd_readahead.xml b/man/sd_readahead.xml index 004608dfb..88b135b7e 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"/> sd_readahead() is - implemented in the reference implementation's drop-in + implemented in the reference implementation's sd-readahead.c and - sd-readahead.h files. It is - recommended that applications consuming this API copy - the implementation into their source tree. For more - details about the reference implementation see - sd-readahead7 - - If -DDISABLE_SYSTEMD is set during compilation - this function will always return 0 and otherwise - become a NOP. + sd-readahead.h files. These + interfaces are available as shared library, which can + be compiled and linked to with the + libsystemd-daemon + pkg-config1 + file. Alternatively, applications consuming this API + may copy the implementation into their source + tree. For more details about the reference + implementation see + sd-readahead7. + + 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.