From 26e3ff59a6a197e442255d8adfa2df239405c7e5 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Wed, 19 Feb 2014 18:19:06 +0100 Subject: [PATCH] man: don't advertise sd-daemon as embeddable anymore It's now part of libsystemd, and should be used like any other API. --- man/sd-daemon.xml | 48 ++++++++----------------------------- man/sd_booted.xml | 34 ++++---------------------- man/sd_is_fifo.xml | 34 ++++---------------------- man/sd_listen_fds.xml | 35 ++++----------------------- man/sd_notify.xml | 35 ++++----------------------- man/sd_watchdog_enabled.xml | 34 ++++---------------------- 6 files changed, 30 insertions(+), 190 deletions(-) diff --git a/man/sd-daemon.xml b/man/sd-daemon.xml index ce4887e40..9eef395de 100644 --- a/man/sd-daemon.xml +++ b/man/sd-daemon.xml @@ -52,7 +52,7 @@ SD_NOTICE SD_INFO SD_DEBUG - Reference implementation of APIs for + APIs for new-style daemons @@ -62,7 +62,7 @@ - pkg-config --cflags --libs libsystemd-daemon + pkg-config --cflags --libs libsystemd @@ -70,10 +70,8 @@ Description - sd-daemon.c and - sd-daemon.h provide a reference - implementation of various APIs for new-style daemons, - as implemented by the + sd-daemon.h provide APIs + for new-style daemons, as implemented by the systemd1 init system. @@ -81,7 +79,8 @@ sd_listen_fds3, sd_notify3, sd_booted3, - sd_is_fifo3 + sd_is_fifo3, + sd_watchdog_enabled3 for more information about the functions implemented. In addition to these functions, a couple of logging prefixes are defined as macros: @@ -126,37 +125,10 @@ Notes - These interfaces are provided by the reference - implementation of APIs for new-style daemons and - distributed with the systemd package. The algorithms - they implement are simple, and can easily be - reimplemented in daemons if it is important to support - this interface without using the reference - implementation. See the respective function man pages - for details. - - In addition, for details about the algorithms, - check the liberally licensed reference implementation - sources: - - and - - These APIs are implemented in the reference - implementation's sd-daemon.c and - sd-daemon.h files. These - interfaces are available as a 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 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. + These APIs are implemented as a shared library, + which can be compiled and linked to with the + libsystemd pkg-config1 + file. diff --git a/man/sd_booted.xml b/man/sd_booted.xml index 1e38d2abd..f699cefb1 100644 --- a/man/sd_booted.xml +++ b/man/sd_booted.xml @@ -76,13 +76,10 @@ Notes - This function is provided by the reference - implementation of APIs for new-style daemons and - distributed with the systemd package. The algorithm it - implements is simple, and can easily be reimplemented - in daemons if it is important to support this - interface without using the reference - implementation. + These APIs are implemented as a shared library, + which can be compiled and linked to with the + libsystemd pkg-config1 + file. Internally, this function checks whether the directory /run/systemd/system/ @@ -90,29 +87,6 @@ implemented trivially in shell or any other language. - For details about the algorithm check the - liberally licensed reference implementation sources: - - and - - sd_booted() is implemented - in the reference implementation's - sd-daemon.c and - sd-daemon.h files. These - interfaces are available as a 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-daemon3. - - 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 58cd1c91b..60684bcee 100644 --- a/man/sd_is_fifo.xml +++ b/man/sd_is_fifo.xml @@ -185,41 +185,15 @@ Notes - These functions are provided by the reference - implementation of APIs for new-style daemons and - distributed with the systemd package. The algorithms - they implement are simple, and they can easily be - reimplemented in daemons if it is important to support - this interface without using the reference - implementation. + These APIs are implemented as a shared library, + which can be compiled and linked to with the + libsystemd pkg-config1 + file. Internally, these function use a combination of fstat() and getsockname() to check the file descriptor type and where it is bound to. - - For details about the algorithms, check the - liberally licensed reference implementation sources: - - and - - sd_is_fifo() and the - related functions are implemented in the reference - implementation's sd-daemon.c and - sd-daemon.h files. These - interfaces are available as a 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-daemon3. - - These functions continue to work as described, - even if -DDISABLE_SYSTEMD is set during - compilation. diff --git a/man/sd_listen_fds.xml b/man/sd_listen_fds.xml index 6a9e08218..88fb77bd2 100644 --- a/man/sd_listen_fds.xml +++ b/man/sd_listen_fds.xml @@ -121,13 +121,10 @@ Notes - This function is provided by the reference - implementation of APIs for new-style daemons and - distributed with the systemd package. The algorithm it - implements is simple, and can easily be reimplemented - in daemons if it is important to support this - interface without using the reference - implementation. + These APIs are implemented as a shared library, + which can be compiled and linked to with the + libsystemd pkg-config1 + file. Internally, this function checks whether the $LISTEN_PID environment variable @@ -138,30 +135,6 @@ number of file descriptors starting from SD_LISTEN_FDS_START. Finally, it returns the parsed number. - - For details about the algorithm check the - liberally licensed reference implementation sources: - - and - - sd_listen_fds() is - implemented in the reference implementation's - sd-daemon.c and - sd-daemon.h files. These - interfaces are available as a 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-daemon3. - - 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 d21820f67..3e530757c 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -211,13 +211,10 @@ Notes - These functions are provided by the reference - implementation of APIs for new-style daemons and - distributed with the systemd package. The algorithms - they implement are simple, and can easily be - reimplemented in daemons if it is important to support - this interface without using the reference - implementation. + These APIs are implemented as a shared library, + which can be compiled and linked to with the + libsystemd pkg-config1 + file. Internally, these functions send a single datagram with the state string as payload to the @@ -228,30 +225,6 @@ understood as Linux abstract namespace socket. The datagram is accompanied by the process credentials of the sending daemon, using SCM_CREDENTIALS. - - For details about the algorithms check the - liberally licensed reference implementation sources: - - and - - sd_notify() and - sd_notifyf() are implemented in - the reference implementation's - sd-daemon.c and - sd-daemon.h files. These - interfaces are available as a 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-daemon3. - - 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_watchdog_enabled.xml b/man/sd_watchdog_enabled.xml index cad92df7a..0e4df3750 100644 --- a/man/sd_watchdog_enabled.xml +++ b/man/sd_watchdog_enabled.xml @@ -115,13 +115,10 @@ Notes - This function is provided by the reference - implementation of APIs for new-style daemons and - distributed with the systemd package. The algorithm - it implements is simple, and can easily be - reimplemented in daemons if it is important to support - this interface without using the reference - implementation. + These APIs are implemented as a shared library, + which can be compiled and linked to with the + libsystemd pkg-config1 + file. Internally, this functions parses the $WATCHDOG_PID and @@ -132,29 +129,6 @@ that case, the variables were set for a different process further up the process tree. - For details about the algorithm, check the - liberally licensed reference implementation sources: - - and - - sd_watchdog_enabled() is - implemented in the reference implementation's - sd-daemon.c and - sd-daemon.h files. These - interfaces are available as a 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-daemon3. - - 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. -- 2.30.2