[systemd-commits] 2 commits - man/sd_booted.xml man/sd-daemon.xml man/sd_is_fifo.xml man/sd_listen_fds.xml man/sd_notify.xml man/sd_readahead.xml

Lennart Poettering lennart at kemper.freedesktop.org
Thu Sep 22 12:17:02 PDT 2011


 man/sd-daemon.xml     |   27 ++++++++++++++++++---------
 man/sd_booted.xml     |   26 ++++++++++++++++----------
 man/sd_is_fifo.xml    |   20 ++++++++++++--------
 man/sd_listen_fds.xml |   26 ++++++++++++++++----------
 man/sd_notify.xml     |   23 ++++++++++++++---------
 man/sd_readahead.xml  |   26 ++++++++++++++++----------
 6 files changed, 92 insertions(+), 56 deletions(-)

New commits:
commit 7712ea6da6833a9e6b5a2810eb8b94e527069e1b
Author: Lennart Poettering <lennart at poettering.net>
Date:   Thu Sep 22 21:16:33 2011 +0200

    man: document pkg-config line for sd-daemon

diff --git a/man/sd-daemon.xml b/man/sd-daemon.xml
index 3f428f4..cd67d99 100644
--- a/man/sd-daemon.xml
+++ b/man/sd-daemon.xml
@@ -52,6 +52,11 @@
                 <funcsynopsis>
                         <funcsynopsisinfo>#include "sd-daemon.h"</funcsynopsisinfo>
                 </funcsynopsis>
+
+                <cmdsynopsis>
+                        <command>pkg-config --cflags --libs libsystemd-daemon</command>
+                </cmdsynopsis>
+
         </refsynopsisdiv>
 
         <refsect1>
@@ -159,7 +164,8 @@
                         <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>fprintf</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>sd-readahead</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+                        <citerefentry><refentrytitle>sd-readahead</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 </para>
         </refsect1>
 

commit 71e6c1cf47c35cc5a58cefaabe4f6848d6f09501
Author: Lennart Poettering <lennart at poettering.net>
Date:   Thu Sep 22 21:13:41 2011 +0200

    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 cbfe28f..3f428f4 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 841ee1d..ebcde36 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 251f45c..f6fafab 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 128d859..3276aff 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 c060bba..dd0ba93 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 004608d..88b135b 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>



More information about the systemd-commits mailing list